Package org.alfresco.rest.rm.community.requests.gscore

Class GSCoreAPI

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Request>

org.alfresco.rest.rm.community.requests.RMModelRequest

org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI

public class GSCoreAPI
extends RMModelRequest

Defines the entire GS Core API {@link http://host:port/gs-api-explorer} select "GS Core API"

Since:

2.6

Author:

Tuna Aksoy

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
GSCoreAPI(RMRestWrapper rmRestWrapper, RMRestProperties rmRestProperties)	Constructor

Method Summary

Modifier and Type	Method	Description
ActionsExecutionAPI	usingActionsExecutionsAPI()	Provides DSL for ActionExecution API
FilePlanAPI	usingFilePlans()	Provides DSL on all REST calls under file-plans/... API path
FilesAPI	usingFiles()	Provides DSL on all REST calls under files/... API path
HoldsAPI	usingHoldsAPI()
RecordCategoryAPI	usingRecordCategory()	Provides DSL on all REST calls under record-categories/... API path
RecordFolderAPI	usingRecordFolder()	Provides DSL on all REST calls under record-folders/... API path
RecordsAPI	usingRecords()	Provides DSL on all REST calls under records/... API path
RetentionScheduleAPI	usingRetentionScheduleAPI()
RMSiteAPI	usingRMSite()	Provides DSL on all REST calls under ig-sites/rm/... API path
RMUserAPI	usingRMUser()	Provides DSL for RM user management API
TransferAPI	usingTransfer()	Provides DSL on all REST calls under transfers/... API path
TransferContainerAPI	usingTransferContainer()	Provides DSL on all REST calls under transfer-containers/... API path
UnfiledContainerAPI	usingUnfiledContainers()	Provides DSL for RM unfiled container API
UnfiledRecordFolderAPI	usingUnfiledRecordFolder()	Provides DSL for RM unfiled record folders API

Methods inherited from class org.alfresco.rest.requests.ModelRequest

include, includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Details

GSCoreAPI

public GSCoreAPI(RMRestWrapper rmRestWrapper,
 RMRestProperties rmRestProperties)

Constructor

Parameters:

rmRestWrapper - RM REST Wrapper

rmRestProperties - RM REST Properties

Method Details

usingRMSite

public RMSiteAPI usingRMSite()

Provides DSL on all REST calls under ig-sites/rm/... API path

Returns:

RMSiteAPI

usingFilePlans

public FilePlanAPI usingFilePlans()

Provides DSL on all REST calls under file-plans/... API path

Returns:

FilePlanAPI

usingRecordCategory

public RecordCategoryAPI usingRecordCategory()

Provides DSL on all REST calls under record-categories/... API path

Returns:

RecordCategoryAPI

usingRecordFolder

public RecordFolderAPI usingRecordFolder()

Provides DSL on all REST calls under record-folders/... API path

Returns:

RecordFolderAPI

usingRecords

public RecordsAPI usingRecords()

Provides DSL on all REST calls under records/... API path

Returns:

RecordsAPI

usingFiles

public FilesAPI usingFiles()

Provides DSL on all REST calls under files/... API path

Returns:

FilesAPI

usingTransferContainer

public TransferContainerAPI usingTransferContainer()

Provides DSL on all REST calls under transfer-containers/... API path

Returns:

TransferContainerAPI

usingTransfer

public TransferAPI usingTransfer()

Provides DSL on all REST calls under transfers/... API path

Returns:

TransferAPI

usingUnfiledContainers

public UnfiledContainerAPI usingUnfiledContainers()

Provides DSL for RM unfiled container API

Returns:

UnfiledContainerAPI

usingUnfiledRecordFolder

public UnfiledRecordFolderAPI usingUnfiledRecordFolder()

Provides DSL for RM unfiled record folders API

Returns:

UnfiledRecordFolderAPI

usingRMUser

public RMUserAPI usingRMUser()

Provides DSL for RM user management API

Returns:

RMUserAPI

usingActionsExecutionsAPI

public ActionsExecutionAPI usingActionsExecutionsAPI()

Provides DSL for ActionExecution API

Returns:

ActionsExecutionAPI

usingHoldsAPI

public HoldsAPI usingHoldsAPI()

usingRetentionScheduleAPI

public RetentionScheduleAPI usingRetentionScheduleAPI()