public interface RESTStatusCode
RESTStatusCode
denotes the "HTTP Status Code" details for the RESTMethod
instances as below.
Category
in CentraSite.
RESTStatusCode
will be used in
RESTMethod.setStatusCodes(Collection statusCodes)
for describing the HTTP Status Code details for the REST/XML Method.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBriefDescription()
Returns the brief description of the status code.
|
java.lang.String |
getDetailedDescription()
Returns the detailed description of the status code.
|
Category |
getHTTPStatusCode()
Gets the status code category of the status code that represents the corresponding W3C specified "HTTP Status Code" in CentraSite.
|
void |
setBriefDescription(java.lang.String briefDesc)
Sets the brief description for status code.
|
void |
setDetailedDescription(java.lang.String detailDescription)
Sets the detailed description for the status code.
|
void |
setHTTPStatusCode(Category httpStatusCode)
Sets the category for the status code.
|
Category getHTTPStatusCode() throws CLLException
Category
of the status code.CLLException
- If an error occurs while fetching the status code category from CentraSite.void setHTTPStatusCode(Category httpStatusCode) throws CLLException
httpStatusCode
- The Category
that represents the corresponding W3C specified "HTTP Status Code" in CentraSite.CLLException
- If an error occurs while setting the HTTP status codejava.lang.String getBriefDescription() throws CLLException
String
which provides a brief descriptionCLLException
- If an error occurs while fetching the brief description.void setBriefDescription(java.lang.String briefDesc) throws CLLException
briefDesc
- The String
value for brief description.CLLException
- If an error occurs while setting the brief description for status code.java.lang.String getDetailedDescription() throws CLLException
String
The detailed description of the status code.CLLException
- If an error occurs while fetching the detailed description of the status code.void setDetailedDescription(java.lang.String detailDescription) throws CLLException
detailDescription
- The String
value for detailed description for status code.CLLException
- If an error occurs while setting the description