Package org.alfresco.rest.v0.service

Class DispositionScheduleService

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.service.DispositionScheduleService

@Service
public class DispositionScheduleService
extends BaseAPI

Service for different disposition schedule actions

Since:

2.6.2

Author:

jcule, cagache

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.rest.core.v0.BaseAPI

BaseAPI.PermissionType, BaseAPI.RETENTION_SCHEDULE, BaseAPI.RM_ACTIONS, BaseAPI.RMProperty

Field Summary

Fields inherited from class org.alfresco.rest.core.v0.BaseAPI

ACTIONS_API, contentService, LOGGER, NODE_PREFIX, NODE_REF_WORKSPACE_SPACES_STORE, RM_ACTIONS_API, RM_SITE_ID, SHARE_ACTION_API, UPDATE_METADATA_API

Constructor Summary

Constructors

Constructor	Description
DispositionScheduleService()

Method Summary

Modifier and Type	Method	Description
void	addAccessionStep(String categoryName, Boolean timeOrEvent, String events, String period, String periodProperty, Boolean combineConditions)	Helper method for adding an accession step
void	addCutOffAfterEventStep(String categoryName, String events)	Helper method for adding a cut off after an event occurs step
void	addCutOffAfterPeriodStep(String categoryName, String period)	Helper method for adding a cut off after period step
void	addDestroyWithGhostingAfterPeriodStep(String categoryName, String period)	Helper method for adding a destroy with ghosting after period
void	addRetainAfterPeriodStep(String categoryName, String period)	Helper method for adding a retain after period step
void	createCategoryRetentionSchedule(String categoryName, Boolean appliedToRecords)	Helper method to create retention schedule with general fields for the given category as admin and apply it to the records

Methods inherited from class org.alfresco.rest.core.v0.BaseAPI

addPropertyToRequest, deleteItem, doDeleteRequest, doGetRequest, doPostJsonRequest, doPostRequest, doPutJsonRequest, doPutRequest, doSlingshotPostJsonRequest, facetedRequest, getFilePlanPath, getItemNodeRef, getNodeRefSpacesStore, getObjectByPath, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValuesByUniquePropertyValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DispositionScheduleService

public DispositionScheduleService()

Method Detail

addRetainAfterPeriodStep

public void addRetainAfterPeriodStep(String categoryName,
                                     String period)

Helper method for adding a retain after period step

Parameters:

categoryName - the category in whose schedule the step will be added

period -

addCutOffAfterPeriodStep

public void addCutOffAfterPeriodStep(String categoryName,
                                     String period)

Helper method for adding a cut off after period step

Parameters:

categoryName - the category in whose schedule the step will be added

period -

addDestroyWithGhostingAfterPeriodStep

public void addDestroyWithGhostingAfterPeriodStep(String categoryName,
                                                  String period)

Helper method for adding a destroy with ghosting after period

Parameters:

categoryName - the category in whose schedule the step will be added

period -

addCutOffAfterEventStep

public void addCutOffAfterEventStep(String categoryName,
                                    String events)

Helper method for adding a cut off after an event occurs step

Parameters:

categoryName - the category in whose schedule the step will be added

events -

addAccessionStep

public void addAccessionStep(String categoryName,
                             Boolean timeOrEvent,
                             String events,
                             String period,
                             String periodProperty,
                             Boolean combineConditions)

Helper method for adding an accession step

Parameters:

timeOrEvent -

events -

period -

periodProperty -

combineConditions -

createCategoryRetentionSchedule

public void createCategoryRetentionSchedule(String categoryName,
                                            Boolean appliedToRecords)

Helper method to create retention schedule with general fields for the given category as admin and apply it to the records

Parameters:

categoryName -

appliedToRecords -