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

Class TransferContainerAPI

java.lang.Object

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

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

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

public class TransferContainerAPI
extends RMModelRequest

Transfer Container REST API Wrapper

Since:

2.6

Author:

Silviu Dinuta

Field Summary

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

restWrapper

Constructor Summary

Constructors

Constructor	Description
TransferContainerAPI(RMRestWrapper rmRestWrapper)

Method Summary

Modifier and Type	Method	Description
TransferContainer	getTransferContainer(String transferContainerId)	see getTransferContainer(String, String)
TransferContainer	getTransferContainer(String transferContainerId, String parameters)	Gets a transfer container.
TransferCollection	getTransfers(String transferContainerId)	see getTransfers(String, String)
TransferCollection	getTransfers(String transferContainerId, String parameters)	Gets the children (transfers) of a transfer container.
TransferContainer	updateTransferContainer(TransferContainer transferContainerModel, String transferContainerId)	see updateTransferContainer(TransferContainer, String, String)
TransferContainer	updateTransferContainer(TransferContainer transferContainerModel, String transferContainerId, String parameters)	Updates a transfer container.

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

TransferContainerAPI

public TransferContainerAPI(RMRestWrapper rmRestWrapper)

Parameters:

rmRestWrapper - RM REST Wrapper

Method Detail

getTransferContainer

public TransferContainer getTransferContainer(String transferContainerId)

see getTransferContainer(String, String)

getTransferContainer

public TransferContainer getTransferContainer(String transferContainerId,
                                              String parameters)

Gets a transfer container.

Parameters:

transferContainerId - The identifier of a transfer container

parameters - The URL parameters to add

Returns:

The TransferContainer for the given transferContainerId

Throws:

RuntimeException - for the following cases:

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

updateTransferContainer

public TransferContainer updateTransferContainer(TransferContainer transferContainerModel,
                                                 String transferContainerId)

see updateTransferContainer(TransferContainer, String, String)

updateTransferContainer

public TransferContainer updateTransferContainer(TransferContainer transferContainerModel,
                                                 String transferContainerId,
                                                 String parameters)

Updates a transfer container.

Parameters:

transferContainerModel - The transfer container model which holds the information

transferContainerId - The identifier of a transfer container

parameters - The URL parameters to add

returns - The updated TransferContainer

Throws:

RuntimeException - for the following cases:

• the update request is invalid or transferContainerId is not a valid format or transferContainerModel is invalid
• authentication fails
• current user does not have permission to update transferContainerId
• transferContainerId does not exist
• the updated name clashes with an existing transfer container in the current file plan
• model integrity exception, including transfer container name with invalid characters

getTransfers

public TransferCollection getTransfers(String transferContainerId)

see getTransfers(String, String)

getTransfers

public TransferCollection getTransfers(String transferContainerId,
                                       String parameters)

Gets the children (transfers) of a transfer container.

Parameters:

transferContainerId - The identifier of a transfer container

parameters - The URL parameters to add

Returns:

The TransferCollection for the given transferContainerId

Throws:

RuntimeException - for the following cases:

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