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

Class RetentionScheduleAPI

java.lang.Object

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

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

org.alfresco.rest.rm.community.requests.gscore.api.RetentionScheduleAPI

public class RetentionScheduleAPI
extends RMModelRequest

Field Summary

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

restWrapper

Constructor Summary

Constructors

Constructor	Description
RetentionScheduleAPI(RMRestWrapper rmRestWrapper)

Method Summary

Modifier and Type	Method	Description
RetentionSchedule	createRetentionSchedule(RetentionSchedule retentionScheduleModel, String recordCategoryId)	See createRetentionSchedule(RetentionSchedule, String, String)
RetentionSchedule	createRetentionSchedule(RetentionSchedule retentionScheduleModel, String recordCategoryId, String parameters)	Creates a retention schedule.
RetentionScheduleActionDefinition	createRetentionScheduleStep(RetentionScheduleActionDefinition retentionScheduleActionDefinition, String retentionScheduleId)	See createRetentionScheduleStep(RetentionScheduleActionDefinition, String) (RetentionSchedule, String, String)}
RetentionScheduleActionDefinition	createRetentionScheduleStep(RetentionScheduleActionDefinition retentionScheduleActionDefinition, String retentionScheduleId, String parameters)	Creates a step in the retention schedule.
RetentionScheduleCollection	getRetentionSchedule(String recordCategoryId)	See getRetentionSchedule(String, String)
RetentionScheduleCollection	getRetentionSchedule(String recordCategoryId, String parameters)	Gets the retentionSchedule of a record category.
RetentionScheduleStepCollection	getRetentionScheduleStep(String recordCategoryId)	See getRetentionScheduleStep(String, String)
RetentionScheduleStepCollection	getRetentionScheduleStep(String retentionScheduleId, String parameters)	Gets the retentionSchedule of a record category.

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

RetentionScheduleAPI

public RetentionScheduleAPI(RMRestWrapper rmRestWrapper)

Parameters:

rmRestWrapper -

Method Details

createRetentionSchedule

public RetentionSchedule createRetentionSchedule(RetentionSchedule retentionScheduleModel,
 String recordCategoryId,
 String parameters)

Creates a retention schedule.

Parameters:

retentionScheduleModel - The retentionSchedule model

recordCategoryId - The identifier of a record category

parameters - The URL parameters to add

Returns:

The created RetentionSchedule

Throws:

RuntimeException - for the following cases:

• recordCategoryId is not a valid format or recordCategoryId is invalid
• authentication fails
• current user does not have permission to add children to recordCategoryId
• recordCategoryId does not exist
• new name clashes with an existing node in the current parent container

createRetentionSchedule

public RetentionSchedule createRetentionSchedule(RetentionSchedule retentionScheduleModel,
 String recordCategoryId)

See createRetentionSchedule(RetentionSchedule, String, String)

getRetentionSchedule

public RetentionScheduleCollection getRetentionSchedule(String recordCategoryId,
 String parameters)

Gets the retentionSchedule of a record category.

Parameters:

recordCategoryId - The identifier of a record category

parameters - The URL parameters to add

Returns:

The RetentionSchedule for the given recordCategoryId

Throws:

RuntimeException - for the following cases:

• authentication fails
• current user does not have permission to read recordCategoryId
• recordCategoryId does not exist

getRetentionSchedule

public RetentionScheduleCollection getRetentionSchedule(String recordCategoryId)

See getRetentionSchedule(String, String)

createRetentionScheduleStep

public RetentionScheduleActionDefinition createRetentionScheduleStep(RetentionScheduleActionDefinition retentionScheduleActionDefinition,
 String retentionScheduleId,
 String parameters)

Creates a step in the retention schedule.

Parameters:

retentionScheduleActionDefinition - The retentionScheduleActionDefinition model

retentionScheduleId - The identifier of a retention schedule id

parameters - The URL parameters to add

Returns:

The created RetentionScheduleActionDefinition

Throws:

RuntimeException - for the following cases:

• retentionScheduleId is not a valid format or retentionScheduleId is invalid
• authentication fails
• current user does not have permission to add children to retentionScheduleId
• retentionScheduleId does not exist
• new name clashes with an existing node in the current parent container

createRetentionScheduleStep

public RetentionScheduleActionDefinition createRetentionScheduleStep(RetentionScheduleActionDefinition retentionScheduleActionDefinition,
 String retentionScheduleId)

See createRetentionScheduleStep(RetentionScheduleActionDefinition, String) (RetentionSchedule, String, String)}

getRetentionScheduleStep

public RetentionScheduleStepCollection getRetentionScheduleStep(String retentionScheduleId,
 String parameters)

Gets the retentionSchedule of a record category.

Parameters:

retentionScheduleId - The identifier of a record category

parameters - The URL parameters to add

Returns:

The RetentionScheduleActionDefinition for the given recordCategoryId

Throws:

RuntimeException - for the following cases:

• authentication fails
• current user does not have permission to read recordCategoryId
• recordCategoryId does not exist

getRetentionScheduleStep

public RetentionScheduleStepCollection getRetentionScheduleStep(String recordCategoryId)

See getRetentionScheduleStep(String, String)