Package org.alfresco.rest.v0

Class CustomDefinitionsAPI

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.CustomDefinitionsAPI

@Component
public class CustomDefinitionsAPI
extends BaseAPI

Methods to make API requests using v0 API on Records Management Custom Model Reference Definitions

Since:

2.6

Author:

Rodica Sutu

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
CustomDefinitionsAPI()

Method Summary

Modifier and Type	Method	Description
void	createRelationship(String adminUser, String adminPassword, int expectedStatus, String recordNodeIdFrom, String recordNodeIdTo, CustomDefinitions relationshipType)
void	createRelationship(String adminUser, String adminPassword, String recordNodeIdFrom, String recordNodeIdTo, CustomDefinitions relationshipType)	Helper method to add custom reference instance to the specified record node
void	deleteRelationship(String adminUser, String adminPassword, String recordNodeIdFrom, String recordNodeIdTo, String relationshipUniqueName)
String	getCustomReferenceId(String adminUser, String adminPassword, String customDefinition)	Helper method to get the reference id for a custom reference
org.json.JSONObject	getRelationshipDetails(String adminUser, String adminPassword, String nodeRef)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDefinitionsAPI

public CustomDefinitionsAPI()

Method Detail

getCustomReferenceId

public String getCustomReferenceId(String adminUser,
                                   String adminPassword,
                                   String customDefinition)

Helper method to get the reference id for a custom reference

Parameters:

adminUser - user with administrative privileges

adminPassword - password for adminUser

customDefinition - custom reference definition name

Returns:

reference id if the customDefinition is found null otherwise

createRelationship

public void createRelationship(String adminUser,
                               String adminPassword,
                               String recordNodeIdFrom,
                               String recordNodeIdTo,
                               CustomDefinitions relationshipType)

Helper method to add custom reference instance to the specified record node

Parameters:

adminUser - user with administrative privileges

adminPassword - password for adminUser

recordNodeIdFrom - node ref to set a custom reference

recordNodeIdTo - node ref of the to record

relationshipType - relation type to be created

Throws:

AssertionError - if the creation fails.

createRelationship

public void createRelationship(String adminUser,
                               String adminPassword,
                               int expectedStatus,
                               String recordNodeIdFrom,
                               String recordNodeIdTo,
                               CustomDefinitions relationshipType)

getRelationshipDetails

public org.json.JSONObject getRelationshipDetails(String adminUser,
                                                  String adminPassword,
                                                  String nodeRef)

deleteRelationship

public void deleteRelationship(String adminUser,
                               String adminPassword,
                               String recordNodeIdFrom,
                               String recordNodeIdTo,
                               String relationshipUniqueName)