|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@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 |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
Map<String,Object> getFaxList(Date receivedBefore,
Date receivedAfter,
String folderRestriction,
String groupRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
throws UciException
Map containing the values for the keys defined in
FaxListProperties.
receivedBefore - limit returned results to faxes received/sent before the given point of timereceivedAfter - limit returned results to faxes received/sent after the given point of timefolderRestriction - 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 usedcountOffset - the offset of the first returned value in the result list after the ordering has been
appliedcountLimit - the count of items returned in the result list
Map containing the results with the properties defined in
FaxListProperties
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).
String getFaxFileUrl(String faxId)
throws UciException
faxId - the id of the fax list entry to retrieve the file for
String
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).
String getFaxFile(String faxId)
throws UciException
UcpFaxListRequests.FaxFileDownload and the returned fileId.
faxId - the id of the fax list entry to retrieve the file for
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).
void deleteFaxListEntry(String faxId)
throws UciException
faxId - the id of the fax list entry to remove
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).
void deleteFaxListEntries(List<String> faxIds)
throws UciException
faxIds - the ids of the fax list entries to remove
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).
void moveFaxListEntry(String faxId,
String destinationFolder)
throws UciException
faxId - the id of the fax list entry to movedestinationFolder - one of the following FaxListEntryFolder FaxListEntryFolder.NEW,
FaxListEntryFolder.OLD or FaxListEntryFolder.PRIVATE -
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.
void moveFaxListEntries(List<String> faxIds,
String destinationFolder)
throws UciException
faxIds - the ids of the fax list entries to movedestinationFolder - one of the following FaxListEntryFolder FaxListEntryFolder.NEW,
FaxListEntryFolder.OLD or FaxListEntryFolder.PRIVATE -
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.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||