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

Class UnfiledContainerAPI

java.lang.Object

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

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

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

public class UnfiledContainerAPI
extends RMModelRequest

Unfiled Container REST API Wrapper

Since:

2.6

Author:

Tuna Aksoy, Ana Bozianu

Field Summary

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

restWrapper

Constructor Summary

Constructors

Constructor	Description
UnfiledContainerAPI(RMRestWrapper rmRestWrapper)

Method Summary

Modifier and Type	Method	Description
UnfiledContainerChild	createUnfiledContainerChild(UnfiledContainerChild unfiledContainerChildModel, String unfiledContainerId)	see createUnfiledContainerChild(UnfiledContainerChild, String, String)
UnfiledContainerChild	createUnfiledContainerChild(UnfiledContainerChild unfiledContainerChildModel, String unfiledContainerId, String parameters)	Creates an unfiled container child.
UnfiledContainer	getUnfiledContainer(String unfiledContainerId)	see getUnfiledContainer(String, String)
UnfiledContainer	getUnfiledContainer(String unfiledContainerId, String parameters)	Gets an unfiled record container.
UnfiledContainerChildCollection	getUnfiledContainerChildren(String unfiledContainerId)	see getUnfiledContainerChildren(String) (String, String)}
UnfiledContainerChildCollection	getUnfiledContainerChildren(String unfiledContainerId, String parameters)	Gets the children of an unfiled records container
UnfiledContainer	updateUnfiledContainer(UnfiledContainer unfiledContainerModel, String unfiledContainerId)	see updateUnfiledContainer(UnfiledContainer, String, String)
UnfiledContainer	updateUnfiledContainer(UnfiledContainer unfiledContainerModel, String unfiledContainerId, String parameters)	Updates an unfiled record container
UnfiledContainerChild	uploadRecord(UnfiledContainerChild unfiledContainerChildModel, String unfiledContainerId, File unfiledContainerChildContent)	Create a record from file resource

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

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

UnfiledContainerAPI

public UnfiledContainerAPI(RMRestWrapper rmRestWrapper)

Parameters:

rmRestWrapper - RM REST Wrapper

Method Detail

getUnfiledContainer

public UnfiledContainer getUnfiledContainer(String unfiledContainerId)

see getUnfiledContainer(String, String)

getUnfiledContainer

public UnfiledContainer getUnfiledContainer(String unfiledContainerId,
                                            String parameters)

Gets an unfiled record container.

Parameters:

unfiledContainerId - The identifier of a unfiled record container

parameters - The URL parameters to add

Returns:

The UnfiledContainer for the given unfiledContainerId

Throws:

RuntimeException - for the following cases:

• unfiledContainerId is not a valid format
• authentication fails
• current user does not have permission to read unfiledContainerId
• unfiledContainerId does not exist

getUnfiledContainerChildren

public UnfiledContainerChildCollection getUnfiledContainerChildren(String unfiledContainerId)

see getUnfiledContainerChildren(String) (String, String)}

getUnfiledContainerChildren

public UnfiledContainerChildCollection getUnfiledContainerChildren(String unfiledContainerId,
                                                                   String parameters)

Gets the children of an unfiled records container

Parameters:

unfiledContainerId - The identifier of an unfiled records container

parameters - The URL parameters to add

Returns:

The UnfiledContainerChildCollection for the given unfiledContainerId

Throws:

RuntimeException - for the following cases:

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

createUnfiledContainerChild

public UnfiledContainerChild createUnfiledContainerChild(UnfiledContainerChild unfiledContainerChildModel,
                                                         String unfiledContainerId)

see createUnfiledContainerChild(UnfiledContainerChild, String, String)

createUnfiledContainerChild

public UnfiledContainerChild createUnfiledContainerChild(UnfiledContainerChild unfiledContainerChildModel,
                                                         String unfiledContainerId,
                                                         String parameters)

Creates an unfiled container child. Can be a record or an unfiled record folder.

Parameters:

unfiledContainerChildModel - The unfiled container child model which holds the information

unfiledContainerId - The identifier of an unfiled container

parameters - The URL parameters to add

Returns:

The created UnfiledContainerChild

Throws:

RuntimeException - for the following cases:

• unfiledContainerId is not a valid format or unfiledContainerChildModel is invalid
• authentication fails
• current user does not have permission to add children to unfiledContainerId
• unfiledContainerId does not exist
• new name clashes with an existing node in the current parent container
• model integrity exception, including node name with invalid characters

uploadRecord

public UnfiledContainerChild uploadRecord(UnfiledContainerChild unfiledContainerChildModel,
                                          String unfiledContainerId,
                                          File unfiledContainerChildContent)

Create a record from file resource

Parameters:

unfiledContainerChildModel - UnfiledContainerChild for electronic record to be created

unfiledContainerChildContent - File pointing to the content of the electronic record to be created

unfiledContainerId - The identifier of a unfiled container

Returns:

newly created UnfiledContainerChild

Throws:

RuntimeException - for invalid recordModel JSON strings

updateUnfiledContainer

public UnfiledContainer updateUnfiledContainer(UnfiledContainer unfiledContainerModel,
                                               String unfiledContainerId)

see updateUnfiledContainer(UnfiledContainer, String, String)

updateUnfiledContainer

public UnfiledContainer updateUnfiledContainer(UnfiledContainer unfiledContainerModel,
                                               String unfiledContainerId,
                                               String parameters)

Updates an unfiled record container

Parameters:

unfiledContainerModel - The unfiled record container model which holds the information

unfiledContainerId - The identifier of an unfiled record container

parameters - The URL parameters to add

returns - The updated UnfiledContainer

Throws:

RuntimeException - for the following cases:

• the update request is invalid or unfiledContainerId is not a valid format or unfiledContainerModel is invalid
• authentication fails
• current user does not have permission to update unfiledContainerId
• unfiledContainerId does not exist
• the updated name clashes with an existing root category of special container in the current fileplan
• model integrity exception, including file name with invalid characters