com.sas.hls.resource.repository
Class ResourceCheckinSpecification

java.lang.Object
  extended by com.sas.hls.resource.repository.ResourceCheckinSpecification
All Implemented Interfaces:
Serializable

public class ResourceCheckinSpecification
extends Object
implements Serializable

The specification of how a new version label for a resource should be created or what its new version number should be.

In general, a ResourceCheckinSpecification with a versionType of MAJOR will indicate the major number field should be incremented by one, a versionType of MINOR will indicate the minor number field should be incremented by one, and CUSTOM allows you to specify exactly what the next version number should be.

When specifying a CUSTOM check in specification, the provided number must be greater than the current version of the resource you are manipulating.

See Also:
Serialized Form

Constructor Summary
ResourceCheckinSpecification(String comment)
           
ResourceCheckinSpecification(String comment, VersionType versionType)
           
ResourceCheckinSpecification(String comment, VersionType versionType, String customVersion)
           
 
Method Summary
 String getComment()
           
 String getCustomVersion()
           
 VersionType getVersionType()
           
 String toString()
           
static VersionType toVersionType(String versionTypeString)
          Convert string to equivalent version type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceCheckinSpecification

public ResourceCheckinSpecification(String comment)
Parameters:
comment - Description or label for the change.

ResourceCheckinSpecification

public ResourceCheckinSpecification(String comment,
                                    VersionType versionType)
Parameters:
comment - Description or label for the change.
versionType - How the next version label should be created.

ResourceCheckinSpecification

public ResourceCheckinSpecification(String comment,
                                    VersionType versionType,
                                    String customVersion)
Parameters:
comment - Description or label for the change.
versionType - How the next version label should be created.
customVersion - The version label to use if versionType is CUSTOM.
Method Detail

toVersionType

public static VersionType toVersionType(String versionTypeString)
Convert string to equivalent version type.

Parameters:
versionTypeString -
Returns:
matching versionType value.

getVersionType

public VersionType getVersionType()
Returns:
How to generate next version label.

getCustomVersion

public String getCustomVersion()
Returns:
Version label to use.

getComment

public String getComment()
Returns:
Description of the change associated with this check in specification.

toString

public String toString()
Overrides:
toString in class Object


Copyright (c) 2014, SAS Institute Inc., Cary, NC, USA