com.hds.hcpaw.fss.api.model

Class CollaborationActivityRequest

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.CollaborationActivityRequest

public abstract class CollaborationActivityRequest
extends BaseFssApiResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollaborationActivityRequest.CollaborationActivityType

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static CollaborationActivityRequest	create(FssApiVersion apiVersion, CollaborationActivityRequest.CollaborationActivityType activityType, java.lang.String pageToken, java.lang.Integer pageSize, PageAction pageAction, java.lang.String language) Returns a versioned CollaborationActivityRequest that is compatible with the specified apiVersion.
CollaborationActivityRequest.CollaborationActivityType	getActivityType()
static java.lang.Class<? extends CollaborationActivityRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the CollaborationActivityRequest that corresponds to the specified apiVersion.
java.lang.String	getLanguage()
PageAction	getPageAction()
java.lang.Integer	getPageSize()
java.lang.String	getPageToken()
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends CollaborationActivityRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                              throws AwUnsupportedApiVersionException

Returns the Class of the CollaborationActivityRequest that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the CollaborationActivityRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static CollaborationActivityRequest create(FssApiVersion apiVersion,
                                                  CollaborationActivityRequest.CollaborationActivityType activityType,
                                                  java.lang.String pageToken,
                                                  java.lang.Integer pageSize,
                                                  PageAction pageAction,
                                                  java.lang.String language)
                                           throws AwUnsupportedApiVersionException

Returns a versioned CollaborationActivityRequest that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the CollaborationActivityRequest

activityType - Type of collaboration activity, must be either SHARE, LINK, or TEAM_MANAGEMENT

pageToken - Token returned in last call to this API, or null

pageSize - Maximum number of entries to return

pageAction - Action to perform for this request (FIRST, LAST, NEXT, PREV)

language - Locale in which activity strings should be returned

Returns:

the constructed CollaborationActivityRequest

Throws:

AwUnsupportedApiVersionException

getActivityType

public CollaborationActivityRequest.CollaborationActivityType getActivityType()

Returns:

the activityType

getPageToken

public java.lang.String getPageToken()

Returns:

the pageToken

getPageSize

public java.lang.Integer getPageSize()

Returns:

the pageSize

getPageAction

public PageAction getPageAction()

Returns:

the pageAction

getLanguage

public java.lang.String getLanguage()

Returns:

the locale for events

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur