|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.siemens.icn.hipath.dls.apiv100.DlsAPIout
public class DlsAPIout
Object returned by DlsAPI requests
All elements are of type String; other types are not used to avoid compatibility problems with different WebService toolkits.
Field Summary | |
---|---|
static int |
DLSAPI_ERROR_ALREADY_EXISTS
the target device already exists |
static int |
DLSAPI_ERROR_AMBIGUOUS
requested object exists more than once in DLS DB |
static int |
DLSAPI_ERROR_BUSY
requested Mobility Enabled Workpoint is already used by a mobile user. |
static int |
DLSAPI_ERROR_CANCELLED
job cancelled |
static int |
DLSAPI_ERROR_EXCEPTION
DLS server exception thrown |
static int |
DLSAPI_ERROR_EXPIRED
job expired |
static int |
DLSAPI_ERROR_FAILED
job failed |
static int |
DLSAPI_ERROR_FATAL
any fatal, not recoverable DLS server error |
static int |
DLSAPI_ERROR_INVALID_LOGON
invalid logon (openSession only) |
static int |
DLSAPI_ERROR_INVALID_MOBILE_USER_PIN
invalid mobile user PIN. |
static int |
DLSAPI_ERROR_INVALID_OBJECT
the operation is not applicable for the selected object Sample: use of e164ModifySipSubscriber() is not allowed for HFA devices |
static int |
DLSAPI_ERROR_INVALID_PARAM
invalid input parameter |
static int |
DLSAPI_ERROR_INVALID_SESSION
invalid session (e.g. sessionRef expired, logoff performed) |
static int |
DLSAPI_ERROR_IS_REGISTERED_DEVICE
a call allowed for virtual devices only was performed for a registered device |
static int |
DLSAPI_ERROR_LOGGED_ON
requested mobile user is currently logged on (elsewhere) and cannot be logged off. |
static int |
DLSAPI_ERROR_NO_MOBILE_USER
requested e164 is not a Mobile User. |
static int |
DLSAPI_ERROR_NOT_FOUND
requested object does not exist in DLS DB |
static int |
DLSAPI_ERROR_NOT_IMPLEMENTED
DlsAPI method not (yet) implemented |
static int |
DLSAPI_ERROR_NOT_LOGGED_ON
requested mobile user is currently not logged on. |
static int |
DLSAPI_ERROR_NOT_MOBILITY_ENABLED
requested e164 is not a Mobility Enabled Workpoint. |
static int |
DLSAPI_ERROR_NOT_PERMITTED
successful logon, but not permitted to execute this DlsAPI method |
static int |
DLSAPI_ERROR_TIMEOUT
request timed out |
static int |
DLSAPI_ERROR_TRY_AGAIN
currently unable to process request; try again later |
static int |
DLSAPI_ERROR_VERIFY
verification failure, e.g. the modifications requested for an object are inconsistent Sample: e164ModifySipSubscriber() with a templateName that has a set of inconsistent attributes regarding the selected subscriber |
static int |
DLSAPI_OK_BOUNDARY
default status for "OK - done" |
static int |
DLSAPI_OK_RUNNING
request OK and accepted by DLS, but job is continued asynchronously |
static java.lang.String |
DLSAPI_REQUEST_ID_ERROR
|
static java.lang.String |
DLSAPI_REQUEST_ID_FINISHED
|
static java.lang.String |
DLSAPI_REQUESTID_STATUS_ACTIVE
Job has been generated |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_CANCELLED
Job has been cancelled |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_CONFIRMED
Job successfully finished; waiting for device to return from restart |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_EXPIRED
Job expired, i.e. device was not available |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_FAILED
Job failed |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_FINISHED
Job successfully finished |
static java.lang.String |
DLSAPI_REQUESTID_STATUS_RUNNING
Job is running |
java.lang.String |
requestID
Relevant in case of methods returning DLSAPI_OK_RUNNING (i.e. asynchronous execution of the request). |
java.lang.String |
result
Contains the requested method's result (if provided), e.g. output of query/get requests. |
java.lang.String |
status
The requested method's return status. |
java.lang.String |
statusText
In case of errors: contains a text in English language, that explains the returned status in more detail. |
Constructor Summary | |
---|---|
DlsAPIout()
|
|
DlsAPIout(int newStatus)
|
|
DlsAPIout(int newStatus,
java.lang.String newStatusText)
|
|
DlsAPIout(int newStatus,
java.lang.String newStatusText,
java.lang.String newResult)
|
|
DlsAPIout(int newStatus,
java.lang.String newStatusText,
java.lang.String newResult,
java.lang.String newRequestID)
|
Method Summary | |
---|---|
java.lang.String |
getRequestID()
|
java.lang.String |
getResult()
|
java.lang.String |
getStatus()
|
java.lang.String |
getStatusText()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public java.lang.String status
public java.lang.String statusText
public java.lang.String result
public java.lang.String requestID
public static final int DLSAPI_OK_BOUNDARY
public static final int DLSAPI_OK_RUNNING
public static final int DLSAPI_ERROR_NOT_IMPLEMENTED
public static final int DLSAPI_ERROR_INVALID_PARAM
public static final int DLSAPI_ERROR_NOT_FOUND
public static final int DLSAPI_ERROR_AMBIGUOUS
public static final int DLSAPI_ERROR_INVALID_LOGON
public static final int DLSAPI_ERROR_NOT_PERMITTED
public static final int DLSAPI_ERROR_INVALID_SESSION
public static final int DLSAPI_ERROR_TRY_AGAIN
public static final int DLSAPI_ERROR_TIMEOUT
public static final int DLSAPI_ERROR_INVALID_OBJECT
public static final int DLSAPI_ERROR_VERIFY
public static final int DLSAPI_ERROR_CANCELLED
public static final int DLSAPI_ERROR_FAILED
public static final int DLSAPI_ERROR_EXPIRED
public static final int DLSAPI_ERROR_ALREADY_EXISTS
public static final int DLSAPI_ERROR_IS_REGISTERED_DEVICE
public static final int DLSAPI_ERROR_EXCEPTION
public static final int DLSAPI_ERROR_FATAL
public static final int DLSAPI_ERROR_NO_MOBILE_USER
DlsAPIv100.mobileUserLogon(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
DlsAPIv100.mobileUserLogoff(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public static final int DLSAPI_ERROR_NOT_MOBILITY_ENABLED
DlsAPIv100.mobileUserLogon(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
DlsAPIv100.mobileUserStatus(java.lang.String, java.lang.String, java.lang.String)
public static final int DLSAPI_ERROR_NOT_LOGGED_ON
DlsAPIv100.mobileUserLogoff(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
DlsAPIv100.mobileUserStatus(java.lang.String, java.lang.String, java.lang.String)
public static final int DLSAPI_ERROR_LOGGED_ON
public static final int DLSAPI_ERROR_BUSY
DlsAPIv100.e164AddSipSubscriber(String, String, String, String, String, String, String, String, String)
DlsAPIv100.e164ModifySipSubscriber(String, String, String, String, String, String, String, String)
DlsAPIv100.e164DeleteSubscriber(String, String, String)
public static final int DLSAPI_ERROR_INVALID_MOBILE_USER_PIN
DlsAPIv100.mobileUserLogon(String, String, String, String, String, String)
DlsAPIv100.mobileUserLogoff(String, String, String, String, String)
public static final java.lang.String DLSAPI_REQUESTID_STATUS_ACTIVE
public static final java.lang.String DLSAPI_REQUESTID_STATUS_RUNNING
public static final java.lang.String DLSAPI_REQUESTID_STATUS_CONFIRMED
public static final java.lang.String DLSAPI_REQUESTID_STATUS_FINISHED
public static final java.lang.String DLSAPI_REQUESTID_STATUS_FAILED
public static final java.lang.String DLSAPI_REQUESTID_STATUS_CANCELLED
public static final java.lang.String DLSAPI_REQUESTID_STATUS_EXPIRED
public static final java.lang.String DLSAPI_REQUEST_ID_ERROR
public static final java.lang.String DLSAPI_REQUEST_ID_FINISHED
Constructor Detail |
---|
public DlsAPIout()
public DlsAPIout(int newStatus)
public DlsAPIout(int newStatus, java.lang.String newStatusText)
public DlsAPIout(int newStatus, java.lang.String newStatusText, java.lang.String newResult)
public DlsAPIout(int newStatus, java.lang.String newStatusText, java.lang.String newResult, java.lang.String newRequestID)
Method Detail |
---|
public java.lang.String getRequestID()
public java.lang.String getResult()
public java.lang.String getStatus()
public java.lang.String getStatusText()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |