public interface RESTParameter extends CentraSiteRegistryObject
RESTParameter
represents the meta data of the REST/XML APIs' (and its resources and methods) parameters which will be
used when accessing the REST/XML API resources using its URL.
AbstractXMLService
: Applicable for all the resources and its methods of the API.
Resource
: Applicable for the specific resource and all its methods.
RESTMethod
: Applicable for the specific method.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDataType()
Returns the data type of the parameter.
|
java.lang.String |
getDefaultValue()
Gets the default value of the parameter.
|
java.lang.String |
getParameterType()
Returns the parameter type of the parameter object.
|
java.util.Collection<java.lang.String> |
getPossibleValues()
Retrieves the list of possible values for the designated parameter.
|
boolean |
isArray()
Tells whether the parameter can hold multiple values or not.
|
boolean |
isRequired()
Tells whether this parameter with appropriate value is required or not while accessing the REST/XML resource.
|
void |
setArray(boolean isArray)
Sets the multiplicity characteristic of the parameter.
|
void |
setDataType(java.lang.String dataType)
Sets the data type of the parameter.
|
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value of the parameter.
|
void |
setParameterType(java.lang.String parameterType)
Sets the parameter type of the parameter object.
|
void |
setPossibleValues(java.util.Collection<java.lang.String> possibleValues)
Defines the list of possible values for the designated parameter.
|
void |
setRequired(boolean isRequired)
Sets the mandatoriness of the parameter.
|
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.lang.String getDataType() throws CLLException
ParameterDataType
String
which is the data type of the parameter.CLLException
- If an error occurs while fetching the data type from the parameter.void setDataType(java.lang.String dataType) throws CLLException
ParameterDataType
dataType
- The data type value.CLLException
- If an error occurs while setting the data type to the parameter.java.lang.String getParameterType() throws CLLException
ParameterType
String
; the parameter type of the parameter object.CLLException
- If an error occurs while fetching the parameter type of the parameter.void setParameterType(java.lang.String parameterType) throws CLLException
ParameterType
parameterType
- The parameter type as String
CLLException
- If an error occurs while setting the parameter type for the parameter.boolean isRequired() throws CLLException
CLLException
- If it fails to check if the parameter is required or not.void setRequired(boolean isRequired) throws CLLException
isRequired
- true if required; otherwise false.CLLException
- Ifboolean isArray() throws CLLException
CLLException
void setArray(boolean isArray) throws CLLException
isArray
- true if the parameter can hold multiple values; otherwise false.CLLException
- If an error occurs while setting the 'multiplicity' characteristic of the parameter.java.lang.String getDefaultValue() throws CLLException
String
the default value of the parameter.CLLException
- If an error occurs while fetching the default value of the parameter.void setDefaultValue(java.lang.String defaultValue) throws CLLException
defaultValue
- The default value of the parameter.CLLException
- If an error occurs while setting the default value for the parameter.java.util.Collection<java.lang.String> getPossibleValues() throws CLLException
Collection
of String
; the possible values of the parameter.CLLException
void setPossibleValues(java.util.Collection<java.lang.String> possibleValues) throws CLLException
possibleValues
- The Collection
of String
; the possible values for the parameter.CLLException
- If an error occurs while setting the possible values for the parameter.