public interface RESTPayload extends CentraSiteRegistryObject
RESTPayload
represents the request and response payloads' details of an API as below.
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.String> |
getExampleRequestContents()
Gets the example request contents and its request content types that are defined for the request request payload object.
|
java.util.Map<CentraSiteFile,java.lang.String> |
getExampleRequestFiles()
Gets the example request files and its request content types that are defined for the request request payload object.
|
java.util.Map<java.lang.String,java.lang.String> |
getExampleResponseContents()
Gets the example response contents and its response content types that are defined for the response payload object.
|
java.util.Map<CentraSiteFile,java.lang.String> |
getExampleResponseFiles()
Gets the example response files and its response content types that are defined for the response payload object.
|
java.util.Collection<RESTParameter> |
getHeaderParameters()
Gets the header parameters that are defined for the response payload object.
|
java.util.Collection<RESTLink> |
getLinkObjects() |
java.util.Collection<RESTMediaType> |
getMediaTypeObject()
Retrives the RESTMediaType properties for the Request and Responses
|
java.util.Map<java.lang.String,java.lang.String> |
getRequestSchemaContents()
Gets the request schema contents and its request content types that are defined for the request request payload object.
|
java.util.Collection<java.lang.String> |
getRequestSchemaContentTypes() |
java.util.Map<CentraSiteFile,java.lang.String> |
getRequestSchemaFiles()
Gets the request schema files and its request content types that are defined for the request request payload object.
|
java.util.Map<java.lang.String,java.lang.String> |
getResponseSchemaContents()
Gets the response schema contents and its response content types that are defined for the response payload object.
|
java.util.Collection<java.lang.String> |
getResponseSchemaContentTypes() |
java.util.Map<CentraSiteFile,java.lang.String> |
getResponseSchemaFiles()
Gets the response schema files and its response content types that are defined for the request response payload object.
|
RESTPayload |
getRESTPayload()
Gets request payloads
RESTPayload of the method object. |
AbstractXMLService |
getService()
Gets the REST service.
|
Category |
getStatusCode()
Gets the status code object which represents the HTTP status code information of the REST response payload.
|
void |
setExampleRequestContents(java.util.Map<java.lang.String,java.lang.String> exampleRequestContents)
Sets the example request content (as a plain text) along with its request content type information to the request payload object.
|
void |
setExampleRequestFiles(java.util.Map<CentraSiteFile,java.lang.String> exampleRequestFiles)
Gets the example request files and its request content types that are defined for the request request payload object.
|
void |
setExampleResponseContents(java.util.Map<java.lang.String,java.lang.String> exampleResponseContents)
Sets the example response content (as a plain text) along with its response content type information to the response payload object.
|
void |
setExampleResponseFiles(java.util.Map<CentraSiteFile,java.lang.String> exampleResponseFiles)
Gets the example response files and its response content types that are defined for the response payload object.
|
void |
setHeaderParameters(java.util.Collection<RESTParameter> parameters)
Sets list of parameters of type 'Header' which can be used in the REST response payload.
|
void |
setLinkObjects(java.util.Collection<RESTLink> restLinks) |
void |
setMediaTypeObject(java.util.Collection<RESTMediaType> mediaTypes)
Sets RESTMediaType properties of the parameter
|
void |
setRequestSchemaContents(java.util.Map<java.lang.String,java.lang.String> requestSchemaContents)
Sets the request schema content (as a plain text) along with its request content type information to the request payload object.
|
void |
setRequestSchemaContentTypes(java.util.Collection<java.lang.String> schemaContentTypes) |
void |
setRequestSchemaFiles(java.util.Map<CentraSiteFile,java.lang.String> requestSchemaFiles)
Sets the request schema files along with request content type information to the
RESTPayload |
void |
setResponseSchemaContents(java.util.Map<java.lang.String,java.lang.String> responseSchemaContents)
Sets the response schema content (as a plain text) along with its response content type information to the response payload object.
|
void |
setResponseSchemaContentTypes(java.util.Collection<java.lang.String> respSchemaContentTypes) |
void |
setResponseSchemaFiles(java.util.Map<CentraSiteFile,java.lang.String> responseSchemaFiles)
Sets the response schema files along with response content type information to the
RESTPayload |
void |
setRESTPayload(RESTPayload requestPayloads)
Sets the request payload objects of type
RESTPayload for the RESTPayload object |
void |
setService(AbstractXMLService service)
Sets the REST service .
|
void |
setStatusCode(Category httpStatusCode)
Sets the status code object for the response payload object.
|
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
void setRequestSchemaFiles(java.util.Map<CentraSiteFile,java.lang.String> requestSchemaFiles) throws CLLException
RESTPayload
requestSchemaFiles
- CLLException
- If error occurs while setting the request schema files to request payload object.java.util.Map<CentraSiteFile,java.lang.String> getRequestSchemaFiles() throws CLLException
CentraSiteFile, @link String>
CLLException
- If error occurs while fetching the request schema files of the request payload.void setRequestSchemaContents(java.util.Map<java.lang.String,java.lang.String> requestSchemaContents) throws CLLException
requestContents
- CLLException
- If error occurs while setting the request schema contents to request payload object.java.util.Map<java.lang.String,java.lang.String> getRequestSchemaContents() throws CLLException
String, @link String>
CLLException
- If error occurs while fetching the request schema contents of the request payload.void setExampleRequestFiles(java.util.Map<CentraSiteFile,java.lang.String> exampleRequestFiles) throws CLLException
exampleRequestFiles
- CLLException
- If error occurs while setting the example request files to request payload object.java.util.Map<CentraSiteFile,java.lang.String> getExampleRequestFiles() throws CLLException
CentraSiteFile, @link String>
CLLException
- If error occurs while fetching the example request files of the request payload.void setExampleRequestContents(java.util.Map<java.lang.String,java.lang.String> exampleRequestContents) throws CLLException
requestContents
- CLLException
- If error occurs while setting the example request contents to request payload object.java.util.Map<java.lang.String,java.lang.String> getExampleRequestContents() throws CLLException
String, @link String>
CLLException
- If error occurs while fetching the example request contents of the request payload.void setStatusCode(Category httpStatusCode) throws CLLException
statusCode
- The RESTStatusCode
object described for the REST response payload object.CLLException
- If an error occurs while setting the status code on REST response payload.Category getStatusCode() throws CLLException
RESTStatusCode
of the response payload object.CLLException
- If an error occurs while fetching the status code of the REST response payload.void setResponseSchemaFiles(java.util.Map<CentraSiteFile,java.lang.String> responseSchemaFiles) throws CLLException
RESTPayload
responseSchemaFiles
- CLLException
- If error occurs while setting the response schema files to response payload object.java.util.Map<CentraSiteFile,java.lang.String> getResponseSchemaFiles() throws CLLException
CentraSiteFile, @link String>
CLLException
- If error occurs while fetching the request schema files of the request payload.void setResponseSchemaContents(java.util.Map<java.lang.String,java.lang.String> responseSchemaContents) throws CLLException
responseSchemaContents
- CLLException
- If error occurs while setting the response schema contents to response payload object.java.util.Map<java.lang.String,java.lang.String> getResponseSchemaContents() throws CLLException
String, @link String>
CLLException
- If error occurs while fetching the response schema contents of the response payload.void setExampleResponseFiles(java.util.Map<CentraSiteFile,java.lang.String> exampleResponseFiles) throws CLLException
exampleResponseFiles
- CLLException
- If error occurs while setting the example response files to response payload object.java.util.Map<CentraSiteFile,java.lang.String> getExampleResponseFiles() throws CLLException
CentraSiteFile, @link String>
CLLException
- If error occurs while fetching the example response files of the response payload.void setExampleResponseContents(java.util.Map<java.lang.String,java.lang.String> exampleResponseContents) throws CLLException
exampleResponseContents
- CLLException
- If error occurs while setting the example request contents to response payload object.java.util.Map<java.lang.String,java.lang.String> getExampleResponseContents() throws CLLException
String, @link String>
CLLException
- If error occurs while fetching the example response contents of the response payload.void setHeaderParameters(java.util.Collection<RESTParameter> parameters) throws CLLException
parameters
- The Collection
of RESTParameter
to be set for the REST response payload.CLLException
- If an error occurs while setting the parameters on the REST response payload.java.util.Collection<RESTParameter> getHeaderParameters() throws CLLException
RESTParameter>
CLLException
- If an error occurs while fetching the parameters on the REST response payload.java.util.Collection<RESTMediaType> getMediaTypeObject() throws CLLException
CLLException
void setMediaTypeObject(java.util.Collection<RESTMediaType> mediaTypes) throws CLLException
mediaType
- CLLException
- If an error occurs while setting the RESTMediaType values for the Request and Responses.java.util.Collection<RESTLink> getLinkObjects() throws CLLException
CLLException
void setLinkObjects(java.util.Collection<RESTLink> restLinks) throws CLLException
CLLException
void setRESTPayload(RESTPayload requestPayloads) throws CLLException
RESTPayload
for the RESTPayload
objectrequestPayloads
- CLLException
- If an error occurs while setting request payloads for the payload object.RESTPayload getRESTPayload() throws CLLException
RESTPayload
of the method object.RESTPayload
of the RESTPayload
object.CLLException
void setRequestSchemaContentTypes(java.util.Collection<java.lang.String> schemaContentTypes) throws CLLException
CLLException
void setResponseSchemaContentTypes(java.util.Collection<java.lang.String> respSchemaContentTypes) throws CLLException
CLLException
java.util.Collection<java.lang.String> getResponseSchemaContentTypes() throws CLLException
CLLException
java.util.Collection<java.lang.String> getRequestSchemaContentTypes() throws CLLException
CLLException
void setService(AbstractXMLService service)
service
- The AbstractXMLService
.AbstractXMLService getService()
AbstractXMLService
of the resource.