PlannerApiResource (PubServerSDK 4.4.0.30000000000000-SNAPSHOT API)

java.lang.Object
- com.priint.pubserver.plannerapi.resource.PlannerApiResource

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccessRight, AssignedAccessRight, AssignedAccessRightPK, BusinessRule, BusinessRuleDefinition, CheckedoutDocument, CheckedoutDocumentPK, ConnectorEntity, Context, Dataset, Document, Download, EntityPlanningReference, File, PageTemplate, PageTemplateBbox, ParamDropDownList, ParamDropDownValue, ParamDropDownValueLanguage, Parameter, ParameterDefinition, Planning, Preference, Publication, PublicationRight, PublicationType, Queue, ServerJob, Session, Spread, Spread, SpreadPreview, Status, StatusGroup, Task, Template, TemplateForPageTemplate, User, UserAccessRight, UserRole, Workflow, WorkflowStep
```
public class PlannerApiResource
extends java.lang.Object
implements java.io.Serializable
```
PlannerApiResource is the base class for all planner REST resource classes. As resource classes we mean classes of objects returning/passing to the rest methods. Every result class should inherit it.
It contains two properties for indicating status of the result. Result can be not correctly processed so one should check the status. Status code is HTTP status code, status message contains the description.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PlannerApiResource()

PlannerApiResource(int statuscode, java.lang.String statusMessage)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getStatuscode()`	HTTP status code, 200 - OK, etc.
`java.lang.String`	`getStatusmessage()`	Description of the status, in most cases the description of failure if status code is not 200
`void`	`setStatuscode(int statuscode)`
`void`	`setStatusmessage(java.lang.String statusmessage)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlannerApiResource
```
public PlannerApiResource()
```

PlannerApiResource

public PlannerApiResource(int statuscode,
                          java.lang.String statusMessage)

Method Detail
- getStatuscode
```
public int getStatuscode()
```
  HTTP status code, 200 - OK, etc. If status code is not set to 200, it means something went wrong
- setStatuscode
```
public void setStatuscode(int statuscode)
```
- getStatusmessage
```
public java.lang.String getStatusmessage()
```
  Description of the status, in most cases the description of failure if status code is not 200
- setStatusmessage
```
public void setStatusmessage(java.lang.String statusmessage)
```