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

Class TransferAPI

java.lang.Object

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

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

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

public class TransferAPI
extends RMModelRequest

Transfer 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
TransferAPI(RMRestWrapper rmRestWrapper)

Method Summary

Modifier and Type	Method	Description
Transfer	getTransfer(String transferId)	see getTransfer(String, String)
Transfer	getTransfer(String transferId, String parameters)	Gets a transfer.
TransferChildCollection	getTransfersChildren(String transferId)	see getTransfersChildren(String, String)
TransferChildCollection	getTransfersChildren(String transferId, String parameters)	Gets the children (record folder or record) of a transfer.

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

TransferAPI

public TransferAPI(RMRestWrapper rmRestWrapper)

Parameters:

rmRestWrapper - RM REST Wrapper

Method Detail

getTransfer

public Transfer getTransfer(String transferId)

see getTransfer(String, String)

getTransfer

public Transfer getTransfer(String transferId,
                            String parameters)

Gets a transfer.

Parameters:

transferId - The identifier of a transfer

parameters - The URL parameters to add

Returns:

The Transfer for the given transferId

Throws:

RuntimeException - for the following cases:

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

getTransfersChildren

public TransferChildCollection getTransfersChildren(String transferId)

see getTransfersChildren(String, String)

getTransfersChildren

public TransferChildCollection getTransfersChildren(String transferId,
                                                    String parameters)

Gets the children (record folder or record) of a transfer.

Parameters:

transferId - The identifier of a transfer

parameters - The URL parameters to add

Returns:

The TransferChildCollection for the given transferId

Throws:

RuntimeException - for the following cases:

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