de.siemens.icn.hipath.dls.apiv100
Class DlsAPIout

java.lang.Object
  extended by de.siemens.icn.hipath.dls.apiv100.DlsAPIout
Direct Known Subclasses:
DeviceAPIout, DeviceDescriptionAPIout, DeviceProfileAPIout, FunctionDescriptionAPIout, LayoutDescriptionAPIout, SipSubscriberDeleteList, SipSubscriberList

public class DlsAPIout
extends java.lang.Object

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

status

public java.lang.String status
The requested method's return status.
It is set to one of the listed DLSAPI_ERROR_* or DLSAPI_OK_* values.
All DLSAPI_ERROR_* values start with '-' i.e. indicate a negative numeric value. Additional error values may be defined if neccessary; i.e. ensure that any unknown value lower than zero is properly handled by your client application.
Values greater than DLSAPI_OK_BOUNDARY may also indicate the number of returned objects (query/list methods) or deleted objects (delete methods); for details see the method's description.


statusText

public java.lang.String statusText
In case of errors: contains a text in English language, that explains the returned status in more detail.


result

public java.lang.String result
Contains the requested method's result (if provided), e.g. output of query/get requests.


requestID

public java.lang.String requestID
Relevant in case of methods returning DLSAPI_OK_RUNNING (i.e. asynchronous execution of the request).
It contains the requestID of the created Job.
Note: can also be a comma-separated list of more than one requestIDs (if more than one job has been created).


DLSAPI_OK_BOUNDARY

public static final int DLSAPI_OK_BOUNDARY
default status for "OK - done"

See Also:
Constant Field Values

DLSAPI_OK_RUNNING

public static final int DLSAPI_OK_RUNNING
request OK and accepted by DLS, but job is continued asynchronously

See Also:
Constant Field Values

DLSAPI_ERROR_NOT_IMPLEMENTED

public static final int DLSAPI_ERROR_NOT_IMPLEMENTED
DlsAPI method not (yet) implemented

See Also:
Constant Field Values

DLSAPI_ERROR_INVALID_PARAM

public static final int DLSAPI_ERROR_INVALID_PARAM
invalid input parameter

See Also:
Constant Field Values

DLSAPI_ERROR_NOT_FOUND

public static final int DLSAPI_ERROR_NOT_FOUND
requested object does not exist in DLS DB

See Also:
Constant Field Values

DLSAPI_ERROR_AMBIGUOUS

public static final int DLSAPI_ERROR_AMBIGUOUS
requested object exists more than once in DLS DB

See Also:
Constant Field Values

DLSAPI_ERROR_INVALID_LOGON

public static final int DLSAPI_ERROR_INVALID_LOGON
invalid logon (openSession only)

See Also:
Constant Field Values

DLSAPI_ERROR_NOT_PERMITTED

public static final int DLSAPI_ERROR_NOT_PERMITTED
successful logon, but not permitted to execute this DlsAPI method

See Also:
Constant Field Values

DLSAPI_ERROR_INVALID_SESSION

public static final int DLSAPI_ERROR_INVALID_SESSION
invalid session (e.g. sessionRef expired, logoff performed)

See Also:
Constant Field Values

DLSAPI_ERROR_TRY_AGAIN

public static final int DLSAPI_ERROR_TRY_AGAIN
currently unable to process request; try again later

See Also:
Constant Field Values

DLSAPI_ERROR_TIMEOUT

public static final int DLSAPI_ERROR_TIMEOUT
request timed out

See Also:
Constant Field Values

DLSAPI_ERROR_INVALID_OBJECT

public static final int DLSAPI_ERROR_INVALID_OBJECT
the operation is not applicable for the selected object
Sample: use of e164ModifySipSubscriber() is not allowed for HFA devices

See Also:
Constant Field Values

DLSAPI_ERROR_VERIFY

public static final 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

See Also:
Constant Field Values

DLSAPI_ERROR_CANCELLED

public static final int DLSAPI_ERROR_CANCELLED
job cancelled

See Also:
Constant Field Values

DLSAPI_ERROR_FAILED

public static final int DLSAPI_ERROR_FAILED
job failed

See Also:
Constant Field Values

DLSAPI_ERROR_EXPIRED

public static final int DLSAPI_ERROR_EXPIRED
job expired

See Also:
Constant Field Values

DLSAPI_ERROR_ALREADY_EXISTS

public static final int DLSAPI_ERROR_ALREADY_EXISTS
the target device already exists

See Also:
Constant Field Values

DLSAPI_ERROR_IS_REGISTERED_DEVICE

public static final int DLSAPI_ERROR_IS_REGISTERED_DEVICE
a call allowed for virtual devices only was performed for a registered device

See Also:
Constant Field Values

DLSAPI_ERROR_EXCEPTION

public static final int DLSAPI_ERROR_EXCEPTION
DLS server exception thrown

See Also:
Constant Field Values

DLSAPI_ERROR_FATAL

public static final int DLSAPI_ERROR_FATAL
any fatal, not recoverable DLS server error

See Also:
Constant Field Values

DLSAPI_ERROR_NO_MOBILE_USER

public static final int DLSAPI_ERROR_NO_MOBILE_USER
requested e164 is not a Mobile User.
This return value is used by DLS mobility methods:

See Also:
Constant Field Values

DLSAPI_ERROR_NOT_MOBILITY_ENABLED

public static final int DLSAPI_ERROR_NOT_MOBILITY_ENABLED
requested e164 is not a Mobility Enabled Workpoint.
This return value is used by DLS mobility methods:

See Also:
Constant Field Values

DLSAPI_ERROR_NOT_LOGGED_ON

public static final int DLSAPI_ERROR_NOT_LOGGED_ON
requested mobile user is currently not logged on.
This return value is used by DLS mobility methods:

See Also:
Constant Field Values

DLSAPI_ERROR_LOGGED_ON

public static final int DLSAPI_ERROR_LOGGED_ON
requested mobile user is currently logged on (elsewhere) and cannot be logged off.
This return value is used by DLS mobility methods:

See Also:
Constant Field Values

DLSAPI_ERROR_BUSY

public static final int DLSAPI_ERROR_BUSY
requested Mobility Enabled Workpoint is already used by a mobile user.
This return value is used by DLS SipSubscriber methods:

See Also:
Constant Field Values

DLSAPI_ERROR_INVALID_MOBILE_USER_PIN

public static final int DLSAPI_ERROR_INVALID_MOBILE_USER_PIN
invalid mobile user PIN.
This return value is used by DLS mobility methods:

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_ACTIVE

public static final java.lang.String DLSAPI_REQUESTID_STATUS_ACTIVE
Job has been generated

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_RUNNING

public static final java.lang.String DLSAPI_REQUESTID_STATUS_RUNNING
Job is running

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_CONFIRMED

public static final java.lang.String DLSAPI_REQUESTID_STATUS_CONFIRMED
Job successfully finished; waiting for device to return from restart

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_FINISHED

public static final java.lang.String DLSAPI_REQUESTID_STATUS_FINISHED
Job successfully finished

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_FAILED

public static final java.lang.String DLSAPI_REQUESTID_STATUS_FAILED
Job failed

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_CANCELLED

public static final java.lang.String DLSAPI_REQUESTID_STATUS_CANCELLED
Job has been cancelled

See Also:
Constant Field Values

DLSAPI_REQUESTID_STATUS_EXPIRED

public static final java.lang.String DLSAPI_REQUESTID_STATUS_EXPIRED
Job expired, i.e. device was not available

See Also:
Constant Field Values

DLSAPI_REQUEST_ID_ERROR

public static final java.lang.String DLSAPI_REQUEST_ID_ERROR
See Also:
Constant Field Values

DLSAPI_REQUEST_ID_FINISHED

public static final java.lang.String DLSAPI_REQUEST_ID_FINISHED
See Also:
Constant Field Values
Constructor Detail

DlsAPIout

public DlsAPIout()

DlsAPIout

public DlsAPIout(int newStatus)

DlsAPIout

public DlsAPIout(int newStatus,
                 java.lang.String newStatusText)

DlsAPIout

public DlsAPIout(int newStatus,
                 java.lang.String newStatusText,
                 java.lang.String newResult)

DlsAPIout

public DlsAPIout(int newStatus,
                 java.lang.String newStatusText,
                 java.lang.String newResult,
                 java.lang.String newRequestID)
Method Detail

getRequestID

public java.lang.String getRequestID()

getResult

public java.lang.String getResult()

getStatus

public java.lang.String getStatus()

getStatusText

public java.lang.String getStatusText()