Index

A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

ABOLISHED - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
actions(List<String>) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
ACTIONS_API - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
ActionsExecutionAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Produces processed results from Core Actions API calls
ActionsExecutionAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
 
ActionsOnRule - Enum Class in org.alfresco.rest.rm.community.model.rules
Action values.
ADD_RECORD_TYPES - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
ADD_TO_HOLD - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
ADD_TO_USER_GROUP - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
addAccessionStep(String, Boolean, String, String, RetentionPeriodProperty, Boolean) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding an accession step
addCapabilitiesToRole(UserRoles, Set<String>) - Method in class org.alfresco.rest.v0.service.RoleService
Add capabilities to a role
addCutOffAfterEventStep(String, String) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a cut off after an event occurs step
addCutOffAfterPeriodStep(String, String, RetentionPeriodProperty) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a cut off after period step
addCutOffImmediatelyStep(String) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a cut off immediately after created date step
addDestroyWithGhostingAfterPeriodStep(String, String, RetentionPeriodProperty) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a destroy step with ghosting after period
addDestroyWithGhostingImmediatelyAfterCutOff(String) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a destroy step with ghosting immediately after CUT OFF date
addDestroyWithoutGhostingAfterPeriodStep(String, String, RetentionPeriodProperty) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a destroy step without ghosting after period
addDispositionScheduleSteps(String, String, String, Map<BaseAPI.RETENTION_SCHEDULE, String>) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Creates a retention schedule steps for the category given as parameter
ADDED - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
 
addItemsToHolds(String, String, int, List<String>, List<String>) - Method in class org.alfresco.rest.v0.HoldsAPI
Adds a list of items (content/record/record folder) to a list of holds
addItemsToHolds(String, String, List<String>, List<String>) - Method in class org.alfresco.rest.v0.HoldsAPI
Adds a list of items (content/record/record folder) to a list of holds
addItemToHold(String, String, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Adds item(content/record/record folder) to the hold
addPropertyToRequest(JSONObject, String, Map<K, String>, Enum<?>) - Method in class org.alfresco.rest.core.v0.BaseAPI
Retrieves the property value and decides if that gets to be added to the request
addRetainAfterPeriodStep(String, String) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a retain after period step
addToHoldAndGetMessage(String, String, int, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Util method to add item(content/record/record folder) to the hold and get the error message
addTransferAfterEventStep(String, String, String) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method for adding a transfer after an event occurs step
addUserPermission(String, UserModel, UserPermissions) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI
Helper method to add permission on a component to user
addWORMLock(RepoTestModel) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
Add WORM lock to a node using v1 actions api
addWORMLock(RepoTestModel, int) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
WORM lock a node for a period of days
ALL_ALLOWANCES_GRANTED_ARE_TERMINATED - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
ALLOWABLE_OPERATIONS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Include options
and() - Method in class org.alfresco.rest.rm.community.model.record.Record
 
APIUtils - Class in org.alfresco.rest.core.v0
Helper methods for use with REST APIs.
applyToChildren(boolean) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
ASPECT_STORE_SELECTOR - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
ASPECT_WORM_LOCK - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
ASPECTS_COMPLETED_RECORD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
ASPECTS_VITAL_RECORD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
ASPECTS_VITAL_RECORD_DEFINITION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
assertLastError() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the last error thrown (if any).
assertStatusCodeIs(HttpStatus) - Method in class org.alfresco.rest.core.RMRestWrapper
Assert that a specific status code is returned.
assertThat() - Method in class org.alfresco.rest.rm.community.model.record.Record
 
assignRoleToUser(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI
Assign RM role to user
assignRoleToUser(String, String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Assign a records management role to a user.
assignUserPermissionsOnCategoryAndRMRole(UserModel, String, UserPermissions, String) - Method in class org.alfresco.rest.v0.service.RoleService
Assign permission on a record category and give the user RM role
ATTACHMENT - Enum constant in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
 
AuditEntry - Class in org.alfresco.rest.rm.community.model.audit
POJO for audit entry
AuditEntry() - Constructor for class org.alfresco.rest.rm.community.model.audit.AuditEntry
 
AuditEvents - Enum Class in org.alfresco.rest.rm.community.model.audit
Enumerates the list of events audited
authenticateUser(UserModel) - Method in class org.alfresco.rest.core.RMRestWrapper
Authenticate specific user to Alfresco REST API
AUTHOR - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 

B

BaseAPI - Class in org.alfresco.rest.core.v0
The base API class containing common methods for making v0 API requests
BaseAPI() - Constructor for class org.alfresco.rest.core.v0.BaseAPI
 
BaseAPI.PermissionType - Enum Class in org.alfresco.rest.core.v0
 
BaseAPI.RETENTION_SCHEDULE - Enum Class in org.alfresco.rest.core.v0
 
BaseAPI.RM_ACTIONS - Enum Class in org.alfresco.rest.core.v0
Used to execute rm actions on a node
BaseAPI.RMProperty - Enum Class in org.alfresco.rest.core.v0
Used to set RM items properties including records, categories and folders
BOX - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 

C

CASE_CLOSED - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
checkAuditLogForEvent(UserModel, AuditEvents, UserModel, String, String, List<Object>) - Method in class org.alfresco.rest.v0.service.RMAuditService
Checks the rm audit log contains the entry for the given event.
checkAuditLogForEvent(UserModel, AuditEvents, UserModel, String, List<Object>) - Method in class org.alfresco.rest.v0.service.RMAuditService
Checks the rm audit log contains the entry for the given event.
checkExceptionIsInAlfrescoLogs(String) - Method in class org.alfresco.rest.rm.community.util.DockerHelper
Helper method to check if the specified exception is thrown in alfresco logs
clearAuditLog() - Method in class org.alfresco.rest.v0.service.RMAuditService
Clear the list of audit entries as admin user.
clearAuditLog(String, String) - Method in class org.alfresco.rest.v0.RMAuditAPI
Clear the list of audit entries.
CLOSE_RECORD_FOLDER - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
closeRecordFolder(String, String, String) - Method in class org.alfresco.rest.v0.RecordFoldersAPI
Close the record folder
COMBINE_DISPOSITION_STEP_CONDITIONS - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
CommonTestUtils - Class in org.alfresco.rest.rm.community.util
A utility class to provide test methods that can be used by the REST and UI tests.
COMPLETE_EVENT - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
COMPLETE_EVENT - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
COMPLETE_RECORD - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
completeEvent(String, String, String, RMEvents, Instant) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Complete an event on the record/record folder
completeRecord(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
completeRecord(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
Complete the record recordId
completeRecord(String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Completes the record given as parameter
COMPLIANCE - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
ConditionsOnRule - Enum Class in org.alfresco.rest.rm.community.model.rules
enum used to find the when condition names options by their value
configureRequestSpec() - Method in class org.alfresco.rest.core.RMRestWrapper
You can handle the request sent to server by calling this method.
containerInheritsRulesFromParent(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Returns the rules inheritance state of the container
CONTENT - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
CONTENT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
CONTENT_NODE_TYPE - Static variable in class org.alfresco.rest.rm.community.model.record.Record
 
CONTENT_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
contentDescription(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
contentService - Variable in class org.alfresco.rest.core.v0.BaseAPI
 
contentTitle(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
convertHTTPResponseToJSON(HttpResponse) - Static method in class org.alfresco.rest.core.v0.APIUtils
Extract the body of a HTTP response as a JSON object.
COPY_TO - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
copyTo(String, String, int, String, List<String>) - Method in class org.alfresco.rest.v0.CopyToAPI
Copy a list of nodes to the target container.
copyTo(String, String, String, List<String>) - Method in class org.alfresco.rest.v0.CopyToAPI
Copy a list of nodes to the target container.
CopyToAPI - Class in org.alfresco.rest.v0
The v0 REST API for copy-to (which supports multi-item copy).
CopyToAPI() - Constructor for class org.alfresco.rest.v0.CopyToAPI
 
CREATE_HOLD - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
CREATE_PERSON - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
CREATE_USER_GROUP - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
createCategoryRetentionSchedule(String, Boolean) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method to create retention schedule with general fields for the given category as admin and apply it to the records/record folders
createCategoryRetentionSchedule(UserModel, String, Boolean) - Method in class org.alfresco.rest.v0.service.DispositionScheduleService
Helper method to create retention schedule with general fields for the given category as user and apply it to the records/ record folders
createCollaboratorWithRMRoleAndPermission(SiteModel, RecordCategory, UserRoles, UserPermissions) - Method in class org.alfresco.rest.v0.service.RoleService
Helper method to create a user with rm role and permissions over the recordCategory and collaborator role in collaboration site
CREATED_DATE - Enum constant in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
Item created date.
createHold(String, String, String, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Util method to create a hold
createHold(String, String, String, String, String, int) - Method in class org.alfresco.rest.v0.HoldsAPI
Util method to create a hold
createHoldAndGetNodeRef(String, String, String, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Create a hold and get the node ref of the hold from the response body
createNewRule() - Static method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
Creates a new object of type Rule Definition
createNonElectronicRecord(String, String, Map<K, String>, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Creates a non-electronic record eg.
createRecord(Record, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
createRecord(Record, String, File) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Create a record from file resource
createRecord(Record, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Creates a record in a record folder child, i.e.
createRecordCategoryChild(RecordCategoryChild, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
createRecordCategoryChild(RecordCategoryChild, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Creates a record category child.
createRecordPath(boolean) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
createRelationship(String, String, int, String, String, CustomDefinitions) - Method in class org.alfresco.rest.v0.CustomDefinitionsAPI
 
createRelationship(String, String, String, String, CustomDefinitions) - Method in class org.alfresco.rest.v0.CustomDefinitionsAPI
Helper method to add custom reference instance to the specified record node
createRetentionSchedule(String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Creates a retention schedule for the category given as parameter
createRMSite(RMSite) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Create the RM site
createRole(String, String, String, String, Set<String>) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Create a new RM role.
createRootRecordCategory(RecordCategory, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
createRootRecordCategory(RecordCategory, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
Creates a root record category.
createRule(String, String, String, RuleDefinition) - Method in class org.alfresco.rest.v0.RulesAPI
Creates a rule for the specified container with given rule properties
createUnfiledContainerChild(UnfiledContainerChild, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
createUnfiledContainerChild(UnfiledContainerChild, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
Creates an unfiled container child.
createUnfiledRecordFolderChild(UnfiledContainerChild, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
createUnfiledRecordFolderChild(UnfiledContainerChild, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Creates an unfiled record folder child.
createUser(String, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI
Creates a user with the given name using the old APIs
createUserAndAssignToRole(String, String, String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
create user and assign to records management role
createUserWithRMRole(String) - Method in class org.alfresco.rest.v0.service.RoleService
Helper method to create a test user with rm role
createUserWithRMRoleAndCategoryPermission(String, RecordCategory, UserPermissions) - Method in class org.alfresco.rest.v0.service.RoleService
Helper method to create a test user with rm role and permissions over the record category
createUserWithRMRoleAndRMNodePermission(String, String, UserPermissions) - Method in class org.alfresco.rest.v0.service.RoleService
Helper method to create a user with rm role and permissions on the node ref
createUserWithSiteRoleRMRoleAndPermission(SiteModel, UserRole, String, UserRoles, UserPermissions) - Method in class org.alfresco.rest.v0.service.RoleService
Helper method to create a test user with a rm role and permissions over a rm component and a role in collaboration site
CustomDefinitions - Enum Class in org.alfresco.rest.rm.community.model.custom
List of existing records management custom references.
CustomDefinitionsAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API on Records Management Custom Model Reference Definitions
CustomDefinitionsAPI() - Constructor for class org.alfresco.rest.v0.CustomDefinitionsAPI
 
CUT_OFF - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
CUT_OFF_ASPECT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
CUT_OFF_DATE - Enum constant in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
Item cut off date.

D

DATE_FILED - Enum constant in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
Record filed date.
DECLARE_AS_RECORD - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
DECLARE_RECORDS_CAP - Static variable in class org.alfresco.rest.rm.community.model.user.UserCapabilities
The id of the declare records capability.
DECLARE_VERSION_AS_RECORD - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
declareAndFile(RepoTestModel, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
Declares and files a document as record to a record folder using v1 actions api
declareAndFileVersionAsRecord(RepoTestModel, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
Declares and file a document version as record to a record folder using v1 actions api
declareAsRecord(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI
Declare file as record
declareAsRecord(RepoTestModel) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
Declares a document as record using v1 actions api
declareDocumentAsRecord(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Declare documents as records
declareDocumentVersionAsRecord(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Declare document version as record
declareVersionAsRecord(RepoTestModel) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
Declares a document version as record using v1 actions api
DECLASSIFICATION_REVIEW - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
DEFAULT_FILE_PLAN_ALIAS - Static variable in class org.alfresco.rest.rm.community.model.recordcategory.RecordCategory
 
DELETE_HOLD - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
DELETE_PERSON - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
DELETE_USER_GROUP - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
deleteAllItemsInContainer(String, String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Deletes every item in the given container
deleteAllRulesOnContainer(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Deletes all the rules on a container and checks they don't exist anymore
deleteCategory(String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Delete a category
deleteFolderInContainer(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Delete a folder inside a container in RM site
deleteHold(String, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Deletes hold using cmis
deleteHold(String, String, String, int) - Method in class org.alfresco.rest.v0.HoldsAPI
Deletes hold using RM Actions API and expect a specific status code
deleteHold(UserModel, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Deletes hold using RM Actions API and expect action to be successful
deleteItem(String, String, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Deletes the category, folder or record given as parameter
deleteRecord(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
Deletes a record.
deleteRecord(String, String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Delete a record from the given path eg.
deleteRecordCategory(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Deletes a record category.
deleteRecordFolder(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Deletes a record folder.
deleteRelationship(String, String, String, String, String) - Method in class org.alfresco.rest.v0.CustomDefinitionsAPI
 
deleteRMSite() - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Delete RM site
deleteRole(String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Delete a created RM role.
deleteRule(String, String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Deletes a rule on a container and checks it doesn't exist anymore
deleteSubCategory(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Delete a sub-category
deleteUnfiledRecordFolder(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Deletes an unfiled record folder.
description(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
DESCRIPTION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
DESCRIPTION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
DESCRIPTION - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
DESTROY - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
disabled(boolean) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
disableRulesInheritance(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Disable inheritance on specific container
displayName - Variable in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
DispositionScheduleService - Class in org.alfresco.rest.v0.service
Service for different disposition schedule actions
DispositionScheduleService() - Constructor for class org.alfresco.rest.v0.service.DispositionScheduleService
 
DockerHelper - Class in org.alfresco.rest.rm.community.util
Helper class for interaction with docker containers
DockerHelper(String) - Constructor for class org.alfresco.rest.rm.community.util.DockerHelper
 
DOD5015 - Enum constant in enum class org.alfresco.rest.rm.community.model.site.RMSiteCompliance
 
doDeleteRequest(String, String, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for Delete requests
doGetRequest(String, String, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for GET requests
doPostJsonRequest(String, String, int, JSONObject, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for POST requests
doPostRequest(String, String, JSONObject, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for POST requests
doPutJsonRequest(String, String, int, JSONObject, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for PUT requests
doPutRequest(String, String, JSONObject, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for PUT requests
doSlingshotPostJsonRequest(String, String, int, JSONObject, String, String...) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method for POST requests to slingshot.

E

EDIT_DISPOSITION_DATE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
emptyTrashcan(String, String) - Method in class org.alfresco.rest.v0.UserTrashcanAPI
Clears the trashcan for the current user
enableRulesInheritance(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Enable inheritance on specific container
END_RETENTION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
event - Variable in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
event audited
eventDisplayName - Variable in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
display name for the event audited
EXECUTE_SCRIPT - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
executeAction(String, String, String, BaseAPI.RM_ACTIONS) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Perform an action on the given content
executeAction(String, String, String, BaseAPI.RM_ACTIONS, ZonedDateTime) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Perform an action on the given content
executeAction(String, String, String, BaseAPI.RM_ACTIONS, ZonedDateTime, int) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Perform an action on the record folder
executeActionAndExpectResponseCode(String, String, String, BaseAPI.RM_ACTIONS, int) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Perform an action on the given content
existsRMSite() - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Checks if the RM site exists or not
export(String, String, int, List<String>) - Method in class org.alfresco.rest.v0.ExportAPI
Export API function to perform Export Operation on items with given noderefs using V0 Export Rest API
ExportAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API for Exporting Items
ExportAPI() - Constructor for class org.alfresco.rest.v0.ExportAPI
 
exportRMNode(String, String, int, String) - Method in class org.alfresco.rest.v0.ExportAPI
Export a single Record/Record Folder/Record Category using V0 Export API
exportRMNodes(String, String, int, List<String>) - Method in class org.alfresco.rest.v0.ExportAPI
Export a list of nodes using V0 Export API
extractErrorMessageFromHttpResponse(HttpResponse) - Static method in class org.alfresco.rest.core.v0.APIUtils
Util method to extract the message string from the HTTP response

F

facetedRequest(String, String, List<NameValuePair>, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Generic faceted request.
facetedSearch(String, String, List<NameValuePair>) - Method in class org.alfresco.rest.v0.SearchAPI
Generic faceted search.
facetedSearchForTerm(String, String, String) - Method in class org.alfresco.rest.v0.SearchAPI
Execute faceted search for term.
FILE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
FILE_PLAN_ALIAS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias
 
FILE_PLAN_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
FILE_TO - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
FilePlan - Class in org.alfresco.rest.rm.community.model.fileplan
POJO for file plan
FilePlan() - Constructor for class org.alfresco.rest.rm.community.model.fileplan.FilePlan
 
FilePlanAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
File plan REST API Wrapper
FilePlanAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
Constructor.
FilePlanComponentAlias - Class in org.alfresco.rest.rm.community.model.fileplancomponents
File plan component alias
FilePlanComponentAlias() - Constructor for class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias
 
FilePlanComponentAspects - Class in org.alfresco.rest.rm.community.model.fileplancomponents
File plan component aspect names constants
FilePlanComponentFields - Class in org.alfresco.rest.rm.community.model.fileplancomponents
File plan component field names constants
FilePlanComponentFields() - Constructor for class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
FilePlanComponentMixIn - Class in org.alfresco.rest.rm.community.util
Mix class for Record POJO class Mix-in annotations are: a way to associate annotations with classes without modifying (target) classes themselves.
FilePlanComponentMixIn() - Constructor for class org.alfresco.rest.rm.community.util.FilePlanComponentMixIn
 
FilePlanComponentType - Class in org.alfresco.rest.rm.community.model.fileplancomponents
File plan component type
FilePlanComponentType() - Constructor for class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
FilePlanProperties - Class in org.alfresco.rest.rm.community.model.fileplan
POJO for file plan properties
FilePlanProperties() - Constructor for class org.alfresco.rest.rm.community.model.fileplan.FilePlanProperties
 
fileRecord(RecordBodyFile, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
File the record recordId into file plan structure based on the location sent via the request body
fileRecord(RecordBodyFile, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
File the record recordId into file plan structure based on the location sent via the request body
FilesAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Files REST API Wrapper
FilesAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI
 
FOLDER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
FROZEN_ASPECT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 

G

generateTestPrefix(Class<?>) - Static method in class org.alfresco.rest.rm.community.util.CommonTestUtils
Generate a prefix to namespace the objects in a test class.
getAction() - Method in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
getActions() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getActionsAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getActionsAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getActionValue() - Method in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
getAlfrescoLogs() - Method in class org.alfresco.rest.rm.community.util.DockerHelper
Get the alfresco container logs
getAuditEntriesFilteredByEvent(UserModel, AuditEvents) - Method in class org.alfresco.rest.v0.service.RMAuditService
Returns a list of rm audit entries filtered by given event
getCapabilitiesForRole(String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Get the capabilities for a given role.
getConfiguredRoles(String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Get all the configured RM roles.
getContentDescription() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getContentProperty(UserModel, String) - Method in class org.alfresco.rest.v0.NodePropertiesAPI
Get the content property for a node
getContentTitle() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getContentUrl(UserModel, String) - Method in class org.alfresco.rest.v0.NodePropertiesAPI
Get the content url (bin name) for a node
getCreateRecordPath() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getCustomReferenceId(String, String, String) - Method in class org.alfresco.rest.v0.CustomDefinitionsAPI
Helper method to get the reference id for a custom reference
getDefinition() - Method in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
Get the name of the custom reference.
getDescription() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getDispositionScheduleNodeRef(String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Get the disposition schedule nodeRef
getEventName() - Method in enum class org.alfresco.rest.core.v0.RMEvents
 
getFilePlan(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
getFilePlan(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
Gets a file plan.
getFilePlanPath() - Static method in class org.alfresco.rest.core.v0.BaseAPI
Retrieve the File Plan path
getFilePlansAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getFilePlansAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getFilesAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getFilesAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getHolds(String, String, String, Boolean, Boolean) - Method in class org.alfresco.rest.v0.HoldsAPI
Get the list of the available holds which have the item node reference if includedInHold parameter is true, otherwise a list of hold node references will be retrieved which do not include the given node reference.
getId() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getItemNodeRef(String, String, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Retrieves the nodeRef of an item (category, folder or record) with the given path
getLastStatus() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the most recently returned status object.
getNextDispositionAction(String, String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Get the Next Disposition Action
getNode(String, String, String) - Method in class org.alfresco.rest.v0.NodeAPI
Get the node metadata using the using the node data webscript: Document List v2 Component
getNodeAPI(RepoTestModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getNodeAPI(UserModel, RepoTestModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getNodeProperties(String, String, String) - Method in class org.alfresco.rest.v0.NodePropertiesAPI
Get the node properties
getNodeRefSpacesStore() - Static method in class org.alfresco.rest.core.v0.BaseAPI
Retrieve the node ref spaces store value
getObjectByPath(String, String, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Retrieve a Cmis object by its path
getParameters() - Method in class org.alfresco.rest.core.RMRestWrapper
 
getPath() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getPeriodProperty() - Method in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
 
getPropertyValue(Map<K, String>, Enum<?>) - Method in class org.alfresco.rest.core.v0.BaseAPI
Util to return the property value from a map
getPropertyValue(JSONObject, String, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method to extract the property value for the given nodeRef and property name
getPropertyValues(JSONObject, String) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method to extract list of properties values from result.
getPropertyValuesByUniquePropertyValue(JSONObject, String, List<String>) - Method in class org.alfresco.rest.core.v0.BaseAPI
Helper method to extract property values from request result and put them in map as a list that corresponds to a unique property value.
getRecord(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
getRecord(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
Gets a record.
getRecord(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Retrieves the record object in case it exists
getRecordCategory(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
getRecordCategory(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Gets a record category.
getRecordCategoryAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRecordCategoryAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRecordCategoryChildren(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
getRecordCategoryChildren(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Gets the children of a record category.
getRecordContent(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
Get the content for the electronic record
getRecordFolder(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
getRecordFolder(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Gets a record folder.
getRecordFolderAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRecordFolderAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRecordFolderChildren(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
getRecordFolderChildren(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Gets the children of a record folder.
getRecordFullName(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Retrieves record full name for given partial name
getRecordNodeRef(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Retrieves the record's nodeRef
getRecordsAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRecordsAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRejectReason() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getRelationshipDetails(String, String, String) - Method in class org.alfresco.rest.v0.CustomDefinitionsAPI
 
getRestWrapper() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the core class that wraps the ReST APIs.
getRetentionProperties(String, String) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Returns a map of retention properties
getRMAuditLog(String, String, int, String) - Method in class org.alfresco.rest.v0.RMAuditAPI
Returns a list of rm audit entries .
getRMAuditLogAll(String, String, int) - Method in class org.alfresco.rest.v0.RMAuditAPI
Returns a list of rm audit entries .
getRMSiteAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRMSiteAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRMUserAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRMUserAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getRoleCapabilities(String) - Method in class org.alfresco.rest.v0.service.RoleService
Get the capabilities for a role
getRootRecordCategories(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
getRootRecordCategories(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
Gets the children (root categories) of a file plan.
getRuleIdWithTitle(String, String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Returns the rule id for the give rule title set on a container
getRulesIdsSetOnContainer(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Retrieves all the ids of the rules set on the container
getRulesSetOnContainer(String, String, String) - Method in class org.alfresco.rest.v0.RulesAPI
Gets all the rules for the specified container with given rule properties
getRuleType() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getRunInBackground() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getSearchAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
When no user is given the default is set to admin
getSearchAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getSite() - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Get the RM site
getStatusCode() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the most recently returned status code.
getTestUser() - Method in class org.alfresco.rest.core.RMRestWrapper
Create a UserModel for a new test user.
getTitle() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
getTransfer(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI
getTransfer(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI
Gets a transfer.
getTransferAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getTransferAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getTransferContainer(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
getTransferContainer(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
Gets a transfer container.
getTransferContainerAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getTransferContainerAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getTransfers(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
getTransfers(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
Gets the children (transfers) of a transfer container.
getTransfersChildren(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI
getTransfersChildren(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI
Gets the children (record folder or record) of a transfer.
getUnfiledContainer(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
getUnfiledContainer(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
Gets an unfiled record container.
getUnfiledContainerChildren(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
getUnfiledContainerChildren(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
Gets the children of an unfiled records container
getUnfiledContainersAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getUnfiledContainersAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getUnfiledRecordFolder(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
getUnfiledRecordFolder(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Gets an unfiled record folder.
getUnfiledRecordFolderChildren(String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
getUnfiledRecordFolderChildren(String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Gets the children of an unfiled record folder
getUnfiledRecordFoldersAPI() - Method in class org.alfresco.rest.core.RestAPIFactory
 
getUnfiledRecordFoldersAPI(UserModel) - Method in class org.alfresco.rest.core.RestAPIFactory
 
getWhenConditionValue() - Method in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
 
GSCoreAPI - Class in org.alfresco.rest.rm.community.requests.gscore
Defines the entire GS Core API {@link http://host:port/gs-api-explorer} select "GS Core API"
GSCoreAPI(RMRestWrapper, RMRestProperties) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Constructor

H

HIDE_RECORD - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
hideRecord(String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Hide in place record
HoldEntry - Class in org.alfresco.rest.rm.community.model.hold
POJO for hold entry
HoldEntry() - Constructor for class org.alfresco.rest.rm.community.model.hold.HoldEntry
 
HOLDS_CONTAINER - Static variable in class org.alfresco.rest.v0.HoldsAPI
 
HoldsAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API for generalized holds
HoldsAPI() - Constructor for class org.alfresco.rest.v0.HoldsAPI
 

I

id(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
ID - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
IdNamePair - Class in org.alfresco.rest.rm.community.model.common
POJO for id/name pair
IdNamePair() - Constructor for class org.alfresco.rest.rm.community.model.common.IdNamePair
 
IN_PLACE_WRITERS - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
INCLUDE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
INHERIT_RULES_API - Static variable in class org.alfresco.rest.v0.RulesAPI
 
INHERIT_RULES_STATE_API - Static variable in class org.alfresco.rest.v0.RulesAPI
 
IS_CLOSED - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
IS_COMPLETED - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
isApplyToChildren() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
isDisabled() - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
ISO_INSTANT_FORMATTER - Static variable in class org.alfresco.rest.core.v0.APIUtils
The ISO instant formatter that formats or parses an instant in UTC, such as '2011-12-03T10:15:305Z' similar with DateTimeFormatter.ISO_INSTANT, but with only 3 nanoseconds

J

jsonToObject(JSONArray, Class<T>) - Static method in class org.alfresco.rest.rm.community.util.PojoUtility
Converting json array into a list of java objects
jsonToObject(JSONObject, Class<T>) - Static method in class org.alfresco.rest.rm.community.util.PojoUtility
Converting json to java object

L

LINK_TO - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
linkRecord(String, String, int, String, List<String>) - Method in class org.alfresco.rest.v0.LinksAPI
Creates the Link
LinksAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API for Linking Records
LinksAPI() - Constructor for class org.alfresco.rest.v0.LinksAPI
 
liveSearchForDocuments(String, String, String) - Method in class org.alfresco.rest.v0.SearchAPI
Execute share live search for documents.
liveSearchForDocumentsAsUser(String, String, String) - Method in class org.alfresco.rest.v0.SearchAPI
Helper method to search for documents as a user using share live search.
LOGGER - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
LOGGER - Static variable in class org.alfresco.rest.v0.RulesAPI
 
LOGIN_SUCCESSFUL - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
LOGIN_UNSUCCESSFUL - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
logsAuditLogAsRecord(String, String, String, String) - Method in class org.alfresco.rest.v0.RMAuditAPI
Logs the Audit Log as Record.

M

mandatoryObject(String, Object) - Static method in class org.alfresco.rest.rm.community.util.ParameterCheck
Checks if a given Object is null or not
mandatoryString(String, String) - Static method in class org.alfresco.rest.rm.community.util.ParameterCheck
Checks if a given String is blank or not, i.e.
MESSAGE - Enum constant in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
 
MOVE_TO - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
moveTo(String, String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Move action
moveToAndExpectFailure(String, String, String, String) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Move action

N

NAME - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
NAME - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
NEXT_VERSION - Enum constant in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
 
NO_LONGER_NEEDED - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
NODE_PREFIX - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
NODE_REF_WORKSPACE_SPACES_STORE - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
NodeAPI - Class in org.alfresco.rest.v0
The v0 REST API for nodes
NodeAPI() - Constructor for class org.alfresco.rest.v0.NodeAPI
 
NodePropertiesAPI - Class in org.alfresco.rest.v0
The v0 API to get the node properties
NodePropertiesAPI() - Constructor for class org.alfresco.rest.v0.NodePropertiesAPI
 
NON_ELECTRONIC_RECORD_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
NUMBER_OF_COPIES - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 

O

OBSOLETE - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 
onModel() - Method in class org.alfresco.rest.rm.community.model.record.Record
 
OPEN_RECORD_FOLDER - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
org.alfresco.rest.core - package org.alfresco.rest.core
 
org.alfresco.rest.core.search - package org.alfresco.rest.core.search
 
org.alfresco.rest.core.v0 - package org.alfresco.rest.core.v0
 
org.alfresco.rest.rm.community.model.audit - package org.alfresco.rest.rm.community.model.audit
 
org.alfresco.rest.rm.community.model.common - package org.alfresco.rest.rm.community.model.common
 
org.alfresco.rest.rm.community.model.custom - package org.alfresco.rest.rm.community.model.custom
 
org.alfresco.rest.rm.community.model.fileplan - package org.alfresco.rest.rm.community.model.fileplan
 
org.alfresco.rest.rm.community.model.fileplancomponents - package org.alfresco.rest.rm.community.model.fileplancomponents
 
org.alfresco.rest.rm.community.model.hold - package org.alfresco.rest.rm.community.model.hold
 
org.alfresco.rest.rm.community.model.record - package org.alfresco.rest.rm.community.model.record
 
org.alfresco.rest.rm.community.model.recordcategory - package org.alfresco.rest.rm.community.model.recordcategory
 
org.alfresco.rest.rm.community.model.recordfolder - package org.alfresco.rest.rm.community.model.recordfolder
 
org.alfresco.rest.rm.community.model.rules - package org.alfresco.rest.rm.community.model.rules
 
org.alfresco.rest.rm.community.model.site - package org.alfresco.rest.rm.community.model.site
 
org.alfresco.rest.rm.community.model.transfer - package org.alfresco.rest.rm.community.model.transfer
 
org.alfresco.rest.rm.community.model.transfercontainer - package org.alfresco.rest.rm.community.model.transfercontainer
 
org.alfresco.rest.rm.community.model.unfiledcontainer - package org.alfresco.rest.rm.community.model.unfiledcontainer
 
org.alfresco.rest.rm.community.model.user - package org.alfresco.rest.rm.community.model.user
 
org.alfresco.rest.rm.community.requests - package org.alfresco.rest.rm.community.requests
 
org.alfresco.rest.rm.community.requests.gscore - package org.alfresco.rest.rm.community.requests.gscore
 
org.alfresco.rest.rm.community.requests.gscore.api - package org.alfresco.rest.rm.community.requests.gscore.api
 
org.alfresco.rest.rm.community.util - package org.alfresco.rest.rm.community.util
 
org.alfresco.rest.v0 - package org.alfresco.rest.v0
 
org.alfresco.rest.v0.service - package org.alfresco.rest.v0.service
 
ORIGINATING_ORGANIZATION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
ORIGINATOR - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
Owner - Class in org.alfresco.rest.rm.community.model.common
POJO for owner parameter
Owner() - Constructor for class org.alfresco.rest.rm.community.model.common.Owner
 

P

ParameterCheck - Class in org.alfresco.rest.rm.community.util
Utility class for checking parameters
PARENT_ID_PARAM - Static variable in class org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI
 
path(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
Path - Class in org.alfresco.rest.rm.community.model.common
POJO for path parameter
Path() - Constructor for class org.alfresco.rest.rm.community.model.common.Path
 
PATH - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PERMISSION_FILE_RECORDS - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
 
PERMISSION_FILING - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
 
PERMISSION_READ_RECORDS - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
 
permissionId - Variable in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
 
PHYSICAL_SIZE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
PojoUtility - Class in org.alfresco.rest.rm.community.util
Utility class for creating the json object
postFolderAction(String, String, JSONObject, String) - Method in class org.alfresco.rest.v0.RecordFoldersAPI
 
postRecordAction(String, String, JSONObject, String) - Method in class org.alfresco.rest.v0.RecordFoldersAPI
 
processEmptyModel(RestRequest) - Method in class org.alfresco.rest.core.RMRestWrapper
Process a response that has no body - basically will need only the status code from it.
processHtmlResponse(RestRequest) - Method in class org.alfresco.rest.core.RMRestWrapper
Process a response that returns a html
processModel(Class<T>, RestRequest) - Method in class org.alfresco.rest.core.RMRestWrapper
Process responses for a single model as RestSiteModel.
processModels(Class<T>, RestRequest) - Method in class org.alfresco.rest.core.RMRestWrapper
Process responses for a collection of models as RestSiteModelsCollection.
PROPERTIES_ACCESSION_INDICATOR - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_AUTHOR - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_BOX - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_CLASSIFICATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Record properties
PROPERTIES_COMPONENT_ID - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
File plan properties
PROPERTIES_COUNT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_DATE_FILED - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_DATE_TIME_ORIGINAL - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_DECLASSIFICATION_REVIEW_COMPLETED_AT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_DECLASSIFICATION_REVIEW_COMPLETED_BY - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_DESCRIPTION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_EXPOSURE_TIME - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_F_NUMBER - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_FILE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_FLASH - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_FOCAL_LENGTH - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_HELD_CHILDREN_COUNT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_IDENTIFIER - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_IS_CLOSED - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Record folder properties
PROPERTIES_ISO_SPEED_RATINGS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_LOCATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_MANUFACTURER - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_MODEL - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_NUMBER_OF_COPIES - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_ORIENTATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_ORIGINAL_NAME - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_OWNER - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_PDF_INDICATOR - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Transfer properties
PROPERTIES_PHYSICAL_SIZE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_PIXEL_X_DIMENSION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_PIXEL_Y_DIMENSION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_ORIGINATING_CREATION_DATE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_ORIGINATING_LOCATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_ORIGINATING_USER_ID - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_AS_OF - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_NAME - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_AUTHORITY - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS_ELIGIBLE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_INSTRUCTIONS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD_EXPRESSION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_HAS_DISPOSITION_SCHEDULE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Common properties for record folders and records
PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RESOLUTION_UNIT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_REVIEW_AS_OF - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_REVIEW_PERIOD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_RMV_VERSIONED - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_ROOT_NODE_REF - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Common properties for file plans, record categories, record folders and records
PROPERTIES_SHELF - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Non-electronic record properties
PROPERTIES_SOFTWARE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_STORAGE_LOCATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_STORE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
CONTENT STORE property
PROPERTIES_TITLE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Common properties for record categories, record folders and records
PROPERTIES_TRANSFER_LOCATION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_VERSION_LABEL - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_VERSION_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Electronic record properties
PROPERTIES_VERSIONED_NODEREF - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_VITAL_RECORD_INDICATOR - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Common properties for record categories and record folders
PROPERTIES_WORM_UNLOCK_DATE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
WORM Unlock Date
PROPERTIES_X_RESOLUTION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PROPERTIES_Y_RESOLUTION - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
 
PUBLICATION_DATE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 

R

Record - Class in org.alfresco.rest.rm.community.model.record
POJO for record
Record() - Constructor for class org.alfresco.rest.rm.community.model.record.Record
 
RECORD_CATEGORY_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
RECORD_FOLDER_NODE_TYPE - Static variable in class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild
 
RECORD_FOLDER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
RECORD_SEARCH_ASPECT - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
RECORD_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
RecordBodyFile - Class in org.alfresco.rest.rm.community.model.record
POJO for File records
RecordBodyFile() - Constructor for class org.alfresco.rest.rm.community.model.record.RecordBodyFile
 
RecordCategoriesAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API on record categories
RecordCategoriesAPI() - Constructor for class org.alfresco.rest.v0.RecordCategoriesAPI
 
RecordCategory - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for record category
RecordCategory() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategory
 
RecordCategoryAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Record category REST API Wrapper
RecordCategoryAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Constructor.
RecordCategoryChild - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for record category child
RecordCategoryChild() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild
 
RecordCategoryChildCollection - Class in org.alfresco.rest.rm.community.model.recordcategory
Handle collection of RecordCategoryChildEntry
RecordCategoryChildCollection() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChildCollection
 
RecordCategoryChildEntry - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for record category child entry
RecordCategoryChildEntry() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChildEntry
 
RecordCategoryChildProperties - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for record category child properties
RecordCategoryChildProperties() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChildProperties
 
RecordCategoryCollection - Class in org.alfresco.rest.rm.community.model.recordcategory
Handle collection of RecordCategoryEntry
RecordCategoryCollection() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryCollection
 
RecordCategoryEntry - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for file plan entry
RecordCategoryEntry() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryEntry
 
RecordCategoryProperties - Class in org.alfresco.rest.rm.community.model.recordcategory
POJO for record category properties
RecordCategoryProperties() - Constructor for class org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryProperties
 
RecordContent - Class in org.alfresco.rest.rm.community.model.record
POJO for record content field
RecordContent() - Constructor for class org.alfresco.rest.rm.community.model.record.RecordContent
 
RecordFolder - Class in org.alfresco.rest.rm.community.model.recordfolder
POJO for record folder
RecordFolder() - Constructor for class org.alfresco.rest.rm.community.model.recordfolder.RecordFolder
 
RecordFolderAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Record folder REST API Wrapper
RecordFolderAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Constructor.
RecordFolderCollection - Class in org.alfresco.rest.rm.community.model.recordfolder
Handle collection of RecordFolderEntry
RecordFolderCollection() - Constructor for class org.alfresco.rest.rm.community.model.recordfolder.RecordFolderCollection
 
RecordFolderEntry - Class in org.alfresco.rest.rm.community.model.recordfolder
POJO for record folder entry
RecordFolderEntry() - Constructor for class org.alfresco.rest.rm.community.model.recordfolder.RecordFolderEntry
 
RecordFolderProperties - Class in org.alfresco.rest.rm.community.model.recordfolder
POJO for record folder properties
RecordFolderProperties() - Constructor for class org.alfresco.rest.rm.community.model.recordfolder.RecordFolderProperties
 
RecordFoldersAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API on records folders
RecordFoldersAPI() - Constructor for class org.alfresco.rest.v0.RecordFoldersAPI
 
RecordProperties - Class in org.alfresco.rest.rm.community.model.record
POJO for record properties
RecordProperties() - Constructor for class org.alfresco.rest.rm.community.model.record.RecordProperties
 
RecordsAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Records REST API Wrapper
RecordsAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API on records
RecordsAPI() - Constructor for class org.alfresco.rest.v0.RecordsAPI
 
RecordsAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
 
REJECT - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
rejectReason(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
rejectRecord(String, String, int, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Reject the record given as parameter
rejectRecord(String, String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Reject the record given as parameter
RELATIVE_PATH - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
Parameters
REMOVE_FROM_HOLD - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
REMOVE_FROM_USER_GROUP - Enum constant in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
 
REMOVE_READ - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
 
REMOVE_READ_AND_FILE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
 
removeCapabilitiesFromRole(UserRoles, Set<String>) - Method in class org.alfresco.rest.v0.service.RoleService
Remove capabilities from a role
REMOVED - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
 
removeFromHoldAndGetMessage(String, String, int, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Util method to remove item(content/record/record folder) from hold and get the error message
removeItemFromHold(String, String, String, String) - Method in class org.alfresco.rest.v0.HoldsAPI
Remove item(content/record/record folder) from hold
removeItemsFromHolds(String, String, int, List<String>, List<String>) - Method in class org.alfresco.rest.v0.HoldsAPI
Remove a list of items (content/record/record folder) from a list of holds
removeItemsFromHolds(String, String, List<String>, List<String>) - Method in class org.alfresco.rest.v0.HoldsAPI
Remove a list of items (content/record/record folder) from a list of holds
RENDITION - Enum constant in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
 
REOPEN_RECORD - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
reOpenRecord(String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Reopens the record given as parameter
reOpenRecordFolder(String, String, String) - Method in class org.alfresco.rest.v0.RecordFoldersAPI
 
REQUEST_INFORMATION - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
RestAPIFactory - Class in org.alfresco.rest.core
REST API Factory which provides access to the APIs
RestAPIFactory() - Constructor for class org.alfresco.rest.core.RestAPIFactory
 
RETENTION_AUTHORITY - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_ELIGIBLE_FIRST_EVENT - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_EVENTS - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_GHOST - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_INSTRUCTIONS - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_LOCATION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_PERIOD - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RETENTION_PERIOD_PROPERTY - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
 
RetentionPeriodProperty - Enum Class in org.alfresco.rest.rm.community.model.recordcategory
The property of the dispositioned item that is used to calculate the "as of" period.
ReviewPeriod - Class in org.alfresco.rest.rm.community.model.common
POJO for the review period parameter
ReviewPeriod() - Constructor for class org.alfresco.rest.rm.community.model.common.ReviewPeriod
 
ReviewPeriodSerializer - Class in org.alfresco.rest.rm.community.util
Utility class for serializing @{FilePlanComponentReviewPeriod}
ReviewPeriodSerializer() - Constructor for class org.alfresco.rest.rm.community.util.ReviewPeriodSerializer
 
RM_ACTIONS_API - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
RM_SITE_ID - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
RMAuditAPI - Class in org.alfresco.rest.v0
The v0 REST API for rm audit logs
RMAuditAPI() - Constructor for class org.alfresco.rest.v0.RMAuditAPI
 
RMAuditService - Class in org.alfresco.rest.v0.service
Produces processed results from RM Audit REST API calls
RMAuditService() - Constructor for class org.alfresco.rest.v0.service.RMAuditService
 
RMEvents - Enum Class in org.alfresco.rest.core.v0
 
RMModelRequest<Request> - Class in org.alfresco.rest.rm.community.requests
RMModelRequest(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.RMModelRequest
 
RMRestProperties - Class in org.alfresco.rest.core
Extends RestProperties to be able to change/add properties
RMRestProperties() - Constructor for class org.alfresco.rest.core.RMRestProperties
 
RMRestWrapper - Class in org.alfresco.rest.core
Extends RestWrapper in order to call GS APIs with our own properties
RMRestWrapper() - Constructor for class org.alfresco.rest.core.RMRestWrapper
 
RMRolesAndActionsAPI - Class in org.alfresco.rest.v0
Methods to make API requests using v0 API on RM items (move, update and other actions) including adding users to RM roles
RMRolesAndActionsAPI() - Constructor for class org.alfresco.rest.v0.RMRolesAndActionsAPI
 
rmSearch(String, String, String, String, String, String) - Method in class org.alfresco.rest.v0.SearchAPI
Generic rm search.
RMSite - Class in org.alfresco.rest.rm.community.model.site
POJO for RM Site component
RMSiteAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
RM Site REST API Wrapper
RMSiteAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Constructor
RMSiteCompliance - Enum Class in org.alfresco.rest.rm.community.model.site
RM Site compliance
RMSiteFields - Class in org.alfresco.rest.rm.community.model.site
RM Site properties from the RM Model Schema "entry": { "id": "string", "guid": "string", "title": "string", "description": "string", "visibility": "org.springframework.social.alfresco.api.entities.Site.Visibility", "compliance": "RMSiteCompliance", "role": "UserRole" }
RMSiteFields() - Constructor for class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
RMUserAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
RM user management API
RMUserAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI
 
ROLE - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
ROLE_RM_ADMIN - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
ROLE_RM_MANAGER - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
ROLE_RM_POWER_USER - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
ROLE_RM_SECURITY_OFFICER - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
ROLE_RM_USER - Enum constant in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
roleId - Variable in enum class org.alfresco.rest.rm.community.model.user.UserRoles
 
RoleService - Class in org.alfresco.rest.v0.service
Produces processed results from roles API calls
RoleService() - Constructor for class org.alfresco.rest.v0.service.RoleService
 
RULE_API - Static variable in class org.alfresco.rest.v0.RulesAPI
 
RuleDefinition - Class in org.alfresco.rest.rm.community.model.rules
A class describing the rule
RuleDefinition() - Constructor for class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
RULES_API - Static variable in class org.alfresco.rest.v0.RulesAPI
 
RulesAPI - Class in org.alfresco.rest.v0
Covers CRUD API operations on rules
RulesAPI() - Constructor for class org.alfresco.rest.v0.RulesAPI
 
ruleType(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
runInBackground(boolean) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 

S

SearchAPI - Class in org.alfresco.rest.v0
Helper methods for performing search using various Alfresco search APIs.
SearchAPI() - Constructor for class org.alfresco.rest.v0.SearchAPI
 
searchForDocumentsAsUser(String, String, String) - Method in class org.alfresco.rest.v0.SearchAPI
Helper method to search for documents as a user using faceted search.
searchForNodeNamesAsUser(String, String, String, String, boolean, boolean) - Method in class org.alfresco.rest.v0.SearchAPI
Search as a user for nodes on site "rm" matching query, using SearchAPI.RM_DEFAULT_RECORD_FILTERS and sorted by sortby
searchForNodePropertyAsUser(String, String, String, String, String, String, boolean, boolean) - Method in class org.alfresco.rest.v0.SearchAPI
Search as a user for nodes on site "rm" matching query, using SearchAPI.RM_DEFAULT_RECORD_FILTERS and sorted by sortby and returns the property value for the given nodeRef and property name
SearchRequestBuilder - Class in org.alfresco.rest.core.search
Builder class for creating a search api request
SearchRequestBuilder() - Constructor for class org.alfresco.rest.core.search.SearchRequestBuilder
Constructor for Search API Request
SEND_EMAIL - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
serialize(ReviewPeriod, JsonGenerator, SerializerProvider) - Method in class org.alfresco.rest.rm.community.util.ReviewPeriodSerializer
 
SET_PROPERTY_VALUE_COLL_SITE - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
SET_PROPERTY_VALUE_RM - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
SET_READ - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
 
SET_READ_AND_FILE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
 
setFieldsBuilder(List<String>) - Method in class org.alfresco.rest.core.search.SearchRequestBuilder
Set the requested fields for the SearchRequest
setPagination(Integer, Integer) - Method in class org.alfresco.rest.core.search.SearchRequestBuilder
Set the pagination properties
setPagingBuilder(Pagination) - Method in class org.alfresco.rest.core.search.SearchRequestBuilder
Set the paging statement for the SearchRequest
setQueryBuilder(RestRequestQueryModel) - Method in class org.alfresco.rest.core.search.SearchRequestBuilder
Set the sql statement for the SearchRequest
setRetentionScheduleGeneralFields(String, String, String, Map<BaseAPI.RETENTION_SCHEDULE, String>, Boolean) - Method in class org.alfresco.rest.v0.RecordCategoriesAPI
Sets retention schedule authority and instructions, also if it is applied to records or folders
setStatusCode(String) - Method in class org.alfresco.rest.core.RMRestWrapper
Set the status code.
setUserPermissionInheritance(String, Boolean) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI
Helper method to set permission inheritance on a file plan component
SHARE_ACTION_API - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
shareDocument(String, String, String) - Method in class org.alfresco.rest.v0.RecordsAPI
Share a document
SHELF - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
STANDARD - Enum constant in enum class org.alfresco.rest.rm.community.model.site.RMSiteCompliance
 
STORAGE_LOCATION - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
STUDY_COMPLETE - Enum constant in enum class org.alfresco.rest.core.v0.RMEvents
 

T

title(String) - Method in class org.alfresco.rest.rm.community.model.rules.RuleDefinition
 
TITLE - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
 
TITLE - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 
toJson(Object) - Static method in class org.alfresco.rest.rm.community.util.PojoUtility
toJson(Object, Class<?>, Class<?>) - Static method in class org.alfresco.rest.rm.community.util.PojoUtility
Converting object to JSON string
Transfer - Class in org.alfresco.rest.rm.community.model.transfer
POJO for Transfer
Transfer() - Constructor for class org.alfresco.rest.rm.community.model.transfer.Transfer
 
TRANSFER - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
TRANSFER_CONTAINER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
TRANSFER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
TransferAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Transfer REST API Wrapper
TransferAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI
 
TransferChild - Class in org.alfresco.rest.rm.community.model.transfer
POJO for transfer child
TransferChild() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferChild
 
TransferChildCollection - Class in org.alfresco.rest.rm.community.model.transfer
Handle collection of TransferChildEntry
TransferChildCollection() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferChildCollection
 
TransferChildEntry - Class in org.alfresco.rest.rm.community.model.transfer
POJO for transfer child entry
TransferChildEntry() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferChildEntry
 
TransferChildProperties - Class in org.alfresco.rest.rm.community.model.transfer
POJO for transfer child properties
TransferChildProperties() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferChildProperties
 
TransferCollection - Class in org.alfresco.rest.rm.community.model.transfer
Handle collection of TransferEntry
TransferCollection() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferCollection
 
TransferContainer - Class in org.alfresco.rest.rm.community.model.transfercontainer
POJO for Transfer Container
TransferContainer() - Constructor for class org.alfresco.rest.rm.community.model.transfercontainer.TransferContainer
 
TransferContainerAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Transfer Container REST API Wrapper
TransferContainerAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
 
TransferContainerProperties - Class in org.alfresco.rest.rm.community.model.transfercontainer
POJO for Transfer Container properties
TransferContainerProperties() - Constructor for class org.alfresco.rest.rm.community.model.transfercontainer.TransferContainerProperties
 
TransferEntry - Class in org.alfresco.rest.rm.community.model.transfer
POJO for transfer entry
TransferEntry() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferEntry
 
TransferProperties - Class in org.alfresco.rest.rm.community.model.transfer
POJO for Transfer properties
TransferProperties() - Constructor for class org.alfresco.rest.rm.community.model.transfer.TransferProperties
 
TRANSFERS_ALIAS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias
 

U

UNDO_CUT_OFF - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
UNDO_EVENT - Enum constant in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
 
undoEvent(String, String, String, RMEvents) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Undo an event on the record/record folder
UNFILED_CONTAINER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
UNFILED_RECORD_FOLDER_TYPE - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType
 
UNFILED_RECORDS_CONTAINER_ALIAS - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias
 
UnfiledContainer - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for unfiled container
UnfiledContainer() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainer
 
UnfiledContainerAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Unfiled Container REST API Wrapper
UnfiledContainerAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
 
UnfiledContainerChild - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for record category child
UnfiledContainerChild() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerChild
 
UnfiledContainerChildCollection - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
Handle collection of UnfiledContainerChildEntry
UnfiledContainerChildCollection() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerChildCollection
 
UnfiledContainerChildEntry - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for record category child entry
UnfiledContainerChildEntry() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerChildEntry
 
UnfiledContainerChildMixin - Class in org.alfresco.rest.rm.community.util
Mix class for Record POJO class Mix-in annotations are: a way to associate annotations with classes without modifying (target) classes themselves.
UnfiledContainerChildMixin() - Constructor for class org.alfresco.rest.rm.community.util.UnfiledContainerChildMixin
 
UnfiledContainerChildProperties - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for record category child properties
UnfiledContainerChildProperties() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerChildProperties
 
UnfiledContainerProperties - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for file plan properties
UnfiledContainerProperties() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerProperties
 
UnfiledRecordFolder - Class in org.alfresco.rest.rm.community.model.unfiledcontainer
POJO for unfiled container
UnfiledRecordFolder() - Constructor for class org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledRecordFolder
 
UnfiledRecordFolderAPI - Class in org.alfresco.rest.rm.community.requests.gscore.api
Unfiled Record Folders REST API Wrapper
UnfiledRecordFolderAPI(RMRestWrapper) - Constructor for class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
 
UPDATE - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
 
UPDATE_METADATA_API - Static variable in class org.alfresco.rest.core.v0.BaseAPI
 
updateFilePlan(FilePlan, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
updateFilePlan(FilePlan, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI
Updates a file plan.
updateMetadata(String, String, String, Map<BaseAPI.RMProperty, String>) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Updates metadata, can be used on records, folders and categories
updateRecord(Record, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
updateRecord(Record, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI
Updates a record.
updateRecordCategory(RecordCategory, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
updateRecordCategory(RecordCategory, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI
Updates a record category.
updateRecordFolder(RecordFolder, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
updateRecordFolder(RecordFolder, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI
Updates a record folder.
updateRMSite(RMSite) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI
Update RM site
updateRole(String, String, String, String, Set<String>) - Method in class org.alfresco.rest.v0.RMRolesAndActionsAPI
Update an existing RM role.
updateRule(String, String, String, RuleDefinition) - Method in class org.alfresco.rest.v0.RulesAPI
Updates a rule for the specified container with given rule properties
updateTransferContainer(TransferContainer, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
updateTransferContainer(TransferContainer, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI
Updates a transfer container.
updateUnfiledContainer(UnfiledContainer, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
updateUnfiledContainer(UnfiledContainer, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
Updates an unfiled record container
updateUnfiledRecordFolder(UnfiledRecordFolder, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
updateUnfiledRecordFolder(UnfiledRecordFolder, String, String) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Updates an unfiled record folder
uploadElectronicRecord(String, String, Map<BaseAPI.RMProperty, String>, String, CMISUtil.DocumentType) - Method in class org.alfresco.rest.v0.RecordsAPI
Uploads an electronic record
uploadRecord(UnfiledContainerChild, String, File) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI
Create a record from file resource
uploadRecord(UnfiledContainerChild, String, File) - Method in class org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI
Create a record from file resource
USER_FULLNAME_PATTERN - Static variable in class org.alfresco.rest.rm.community.util.CommonTestUtils
The default pattern used for the user full name when users are created with tas utility
UserCapabilities - Class in org.alfresco.rest.rm.community.model.user
Constants for RM user capabilities
UserCapabilities() - Constructor for class org.alfresco.rest.rm.community.model.user.UserCapabilities
 
UserPermissions - Enum Class in org.alfresco.rest.rm.community.model.user
Constants for RM user capabilities
UserRoles - Enum Class in org.alfresco.rest.rm.community.model.user
Constants for RM user roles
UserTrashcanAPI - Class in org.alfresco.rest.v0
Helper methods for performing actions on user trashcan
UserTrashcanAPI() - Constructor for class org.alfresco.rest.v0.UserTrashcanAPI
 
usingActionsExecutionsAPI() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL for ActionExecution API
usingFilePlans() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under file-plans/... API path
usingFiles() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under files/... API path
usingRecordCategory() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under record-categories/... API path
usingRecordFolder() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under record-folders/... API path
usingRecords() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under records/... API path
usingRMSite() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under ig-sites/rm/... API path
usingRMUser() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL for RM user management API
usingTransfer() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under transfers/... API path
usingTransferContainer() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL on all REST calls under transfer-containers/... API path
usingUnfiledContainers() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL for RM unfiled container API
usingUnfiledRecordFolder() - Method in class org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI
Provides DSL for RM unfiled record folders API

V

valueOf(String) - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.core.v0.RMEvents
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.site.RMSiteCompliance
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.alfresco.rest.rm.community.model.user.UserRoles
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.PermissionType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RETENTION_SCHEDULE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RM_ACTIONS
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.core.v0.BaseAPI.RMProperty
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.core.v0.RMEvents
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.audit.AuditEvents
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.custom.CustomDefinitions
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.rules.ConditionsOnRule
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.site.RMSiteCompliance
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.user.UserPermissions
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.alfresco.rest.rm.community.model.user.UserRoles
Returns an array containing the constants of this enum class, in the order they are declared.
VERSION_AS_RECORD - Static variable in class org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects
 
VIEW_RECORDS_CAP - Static variable in class org.alfresco.rest.rm.community.model.user.UserCapabilities
The id of the view records capability.
VISIBILITY - Static variable in class org.alfresco.rest.rm.community.model.site.RMSiteFields
 

W

withCoreAPI() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the Alfresco Core API.
withGSCoreAPI() - Method in class org.alfresco.rest.core.RMRestWrapper
 
withSearchAPI() - Method in class org.alfresco.rest.core.RMRestWrapper
Get the Alfresco Search API.
WORM_LOCK - Enum constant in enum class org.alfresco.rest.rm.community.model.rules.ActionsOnRule
 
A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values