de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UcpFaxListRequests


@RpcInterface(value="ucp.v30.requests.faxList")
@UciService(value="ucp.v30.requests.faxList")
public interface UcpFaxListRequests

This interface defines the fax list requests provided by the UCI server.


Nested Class Summary
static interface UcpFaxListRequests.FaxFileDownload
          This interface defines the RPC methods that can be used to download the fax files
 
Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void deleteFaxListEntries(List<String> faxIds)
          Remove multiple fax list entries from the list
 void deleteFaxListEntry(String faxId)
          Remove a fax list entry from the list
 String getFaxFile(String faxId)
          Prepares the download of the fax file for the given fax id.
 String getFaxFileUrl(String faxId)
          Creates and returns a temporary URL that can be used to download the fax file for the next 15 minutes.
 Map<String,Object> getFaxList(Date receivedBefore, Date receivedAfter, String folderRestriction, String groupRestriction, String orderProperty, String orderDirection, int countOffset, int countLimit)
          Retrieve a list of received and sent faxes of the current user.
 void moveFaxListEntries(List<String> faxIds, String destinationFolder)
          Move multiple fax list entries to another folder
 void moveFaxListEntry(String faxId, String destinationFolder)
          Move a fax list entry to another folder
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

getFaxList

Map<String,Object> getFaxList(Date receivedBefore,
                              Date receivedAfter,
                              String folderRestriction,
                              String groupRestriction,
                              String orderProperty,
                              String orderDirection,
                              int countOffset,
                              int countLimit)
                              throws UciException
Retrieve a list of received and sent faxes of the current user. The number of entries retrieved can be restricted by several parameters of this procedure call. The results are returned as Map containing the values for the keys defined in FaxListProperties.

Parameters:
receivedBefore - limit returned results to faxes received/sent before the given point of time
receivedAfter - limit returned results to faxes received/sent after the given point of time
folderRestriction - restrict returned results to faxes in the given folder defined in FaxListEntryFolder. If an empty String is given no restriction is used.
groupRestriction - restrict returned results to those conducted by a specified group. Possible choices are the String GroupRestriction.NON_GROUP to return all faxes that do not belong to any group, the id of a group to restrict the list to the faxes belonging to that group and the empty String to return all faxes without restriction.
orderProperty - give the name of one of the FaxListEntryProperties to order results by the value of the property, when an empty String is given the default FaxListEntryProperties.receptionTime is used.
orderDirection - give the name of one of the OrderDirections to define the ordering. If not set the default order direction of the property will be used
countOffset - the offset of the first returned value in the result list after the ordering has been applied
countLimit - the count of items returned in the result list
Returns:
a Map containing the results with the properties defined in FaxListProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getFaxFileUrl

String getFaxFileUrl(String faxId)
                     throws UciException
Creates and returns a temporary URL that can be used to download the fax file for the next 15 minutes.

Parameters:
faxId - the id of the fax list entry to retrieve the file for
Returns:
The download URL as String
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getFaxFile

String getFaxFile(String faxId)
                  throws UciException
Prepares the download of the fax file for the given fax id. After a calling this request the file can be downloaded using the interface UcpFaxListRequests.FaxFileDownload and the returned fileId.

Parameters:
faxId - the id of the fax list entry to retrieve the file for
Returns:
The fileId that can be used to download the file from STARFACE
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

deleteFaxListEntry

void deleteFaxListEntry(String faxId)
                        throws UciException
Remove a fax list entry from the list

Parameters:
faxId - the id of the fax list entry to remove
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

deleteFaxListEntries

void deleteFaxListEntries(List<String> faxIds)
                          throws UciException
Remove multiple fax list entries from the list

Parameters:
faxIds - the ids of the fax list entries to remove
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

moveFaxListEntry

void moveFaxListEntry(String faxId,
                      String destinationFolder)
                      throws UciException
Move a fax list entry to another folder

Parameters:
faxId - the id of the fax list entry to move
destinationFolder - one of the following FaxListEntryFolder FaxListEntryFolder.NEW, FaxListEntryFolder.OLD or FaxListEntryFolder.PRIVATE -
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException). A UciIllegalArgumentException will be raised if the request tries to move a fax to the FaxListEntryFolder.SENT folder.

moveFaxListEntries

void moveFaxListEntries(List<String> faxIds,
                        String destinationFolder)
                        throws UciException
Move multiple fax list entries to another folder

Parameters:
faxIds - the ids of the fax list entries to move
destinationFolder - one of the following FaxListEntryFolder FaxListEntryFolder.NEW, FaxListEntryFolder.OLD or FaxListEntryFolder.PRIVATE -
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException). A UciIllegalArgumentException will be raised if the request tries to move a fax to the FaxListEntryFolder.SENT folder.


Copyright © 2012 STARFACE GmbH. All rights reserved.