com.waveset.object
Class IAPIUser

java.lang.Object
  extended bycom.waveset.util.AbstractXmlObject
      extended bycom.waveset.object.IAPI
          extended bycom.waveset.object.IAPIUser
All Implemented Interfaces:
javax.naming.Referenceable, XmlObject

Deprecated. - Adapters should use com.waveset.adapter.iapi.IAPIUser.

This class is preserved solely for backward-compatibility. It will not work unless the IDM server classes are available.

public class IAPIUser
extends IAPI


Nested Class Summary
 
Nested classes inherited from class com.waveset.object.IAPI
IAPI.IAPIException, IAPI.InternalErrorException, IAPI.MissingRequiredAttributeException, IAPI.UnimplementedException, IAPI.UnknownAttributeException
 
Field Summary
static java.lang.String code_id
          Deprecated.  
static java.lang.String FORM_CANCEL_PROCESSING
          Deprecated.  
 
Fields inherited from class com.waveset.object.IAPI
_clIAPI, _clIAPIFactory, _objIAPI, ATT_CANCEL_OPTION, ATT_CHECKIN_OPTIONS, ATTRIBUTE_FUTURE_DATA, ATTRIBUTE_FUTURE_DATA_ATTRIBUTES, ATTRIBUTE_FUTURE_DATA_EFFECTIVE_DATE, ATTRIBUTE_FUTURE_DATA_WORKFLOW, COMMAND_CREATE, COMMAND_DELETE, COMMAND_GET, COMMAND_LIST, COMMAND_UPDATE, ELEMENT, OPTION_CREATE_IF_MISSING, OPTION_DELETE_EVENT_DETECTED, OPTION_FUTURE_DATA_WORKFLOW, OPTION_REMOTE_ADMIN_NAME, RA_FORM, RA_LOG_LEVEL, RA_LOG_PATH, RA_LOG_SIZE, RA_NAME, RA_PROXY_ADMINISTRATOR, trace, TRACE_LEVEL_DEBUG, TRACE_LEVEL_ERROR, TRACE_LEVEL_INFO, TRACE_LEVEL_NONE, TRACE_LEVEL_WARNING
 
Fields inherited from class com.waveset.util.AbstractXmlObject
_trace
 
Constructor Summary
IAPIUser()
          Deprecated.  
IAPIUser(org.w3c.dom.Element e)
          Deprecated. - Never used. May be removed in the future.
IAPIUser(java.util.Map options, java.util.Map attributes, java.lang.String command, java.util.Map sourceAttributes)
          Deprecated. - Use IAPIUser(Map, Map, command, ResourceAdapterBase). Otherwise, we won't have the LighthouseContext initialization needs.
IAPIUser(java.util.Map options, java.util.Map attributes, java.lang.String command, Resource source)
          Deprecated. - Use com.waveset.adapter.iapi.IAPIFactory.getIAPIUser(Map, Map, command, ResourceAdapterBase). Otherwise, we won't have the LighthouseContext initialization needs.
 
Method Summary
 WavesetResult cancel()
          Deprecated. For a command with an asynchronous execution (workflow suspension), attempt to cancel the command.
 java.util.List find(java.util.List attrNames, java.util.List values, java.util.List conditions, int maxToFind)
          Deprecated. Return a list of view ids that match the conditions.
 java.util.List find(java.lang.String attrName, java.lang.String value, int maxToFind, boolean contains)
          Deprecated. Find the first maxToFind entries that match the parameters.
 java.util.Set getOptionalAttributeNames()
          Deprecated. This is called by IAPI to get the required resources attributes for a call.
 java.util.Set getRequiredAttributeNames()
          Deprecated. This is called by IAPI to get the required resource attributes for a call.
 WavesetResult getResult()
          Deprecated. For a command with an asynchronous execution (workflow suspension), get the result.
static void main(java.lang.String[] args)
          Deprecated.  
 WavesetResult submit()
          Deprecated. This is the main method.
 
Methods inherited from class com.waveset.object.IAPI
addXmlHeader, delete, getApplicationName, getAttributeNamespace, getAttributes, getCommand, getElementName, getNoGlobalAattributes, getOptions, getProperty, getRetryCount, getRetryInterval, getStringConstant, getSubject, getTraceFile, getTraceLevel, getType, getViewID, removeProperty, setAttributeNamespace, setAttributes, setCommand, setLogger, setNoGlobalAattributes, setOptions, setProperty, setTraceFile, setTraceLevel, setType, setViewID, throwIAPIException, throwWavesetException, toString, toXml, toXml, toXml, traceLevelSet, traceString, traceString
 
Methods inherited from class com.waveset.util.AbstractXmlObject
cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

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

FORM_CANCEL_PROCESSING

public static final java.lang.String FORM_CANCEL_PROCESSING
Deprecated. 
Constructor Detail

IAPIUser

public IAPIUser(java.util.Map options,
                java.util.Map attributes,
                java.lang.String command,
                Resource source)
         throws IAPI.IAPIException
Deprecated. - Use com.waveset.adapter.iapi.IAPIFactory.getIAPIUser(Map, Map, command, ResourceAdapterBase). Otherwise, we won't have the LighthouseContext initialization needs.


IAPIUser

public IAPIUser(java.util.Map options,
                java.util.Map attributes,
                java.lang.String command,
                java.util.Map sourceAttributes)
         throws IAPI.IAPIException
Deprecated. - Use IAPIUser(Map, Map, command, ResourceAdapterBase). Otherwise, we won't have the LighthouseContext initialization needs.


IAPIUser

public IAPIUser(org.w3c.dom.Element e)
         throws WavesetException
Deprecated. - Never used. May be removed in the future.

Build an object by parsing its DOM representation.


IAPIUser

public IAPIUser()
Deprecated. 
Method Detail

submit

public WavesetResult submit()
Deprecated. 
This is the main method. Based on the command, options, and attributes set in the constructor, perform the requested command on the user view (get, change, create, delete).

Specified by:
submit in class IAPI

getResult

public WavesetResult getResult()
Deprecated. 
For a command with an asynchronous execution (workflow suspension), get the result. Useful when the command completes to get the final result.

Specified by:
getResult in class IAPI

cancel

public WavesetResult cancel()
Deprecated. 
For a command with an asynchronous execution (workflow suspension), attempt to cancel the command.

Specified by:
cancel in class IAPI

find

public java.util.List find(java.lang.String attrName,
                           java.lang.String value,
                           int maxToFind,
                           boolean contains)
                    throws IAPI.IAPIException
Deprecated. 
Find the first maxToFind entries that match the parameters. Must be overridden to fill in the type.

Specified by:
find in class IAPI
Parameters:
attrName - - the attribute name to search on. See ...
value - - the value of the named attribute
contains - - true: match any that contain value. false match only those that equal value
Returns:
the list of matches. A List of String objects that can be used to create a resource event.
Throws:
IAPI.IAPIException

find

public java.util.List find(java.util.List attrNames,
                           java.util.List values,
                           java.util.List conditions,
                           int maxToFind)
                    throws IAPI.IAPIException
Deprecated. 
Return a list of view ids that match the conditions.

Specified by:
find in class IAPI
Parameters:
attrNames - - attribute names to match
values - - values for the attributes
conditions - - comparison conditions
maxToFind - - return no more than this number of matches
Returns:
a List of matching view ids, or a null list if no matches.
Throws:
IAPI.IAPIException

getRequiredAttributeNames

public java.util.Set getRequiredAttributeNames()
Deprecated. 
This is called by IAPI to get the required resource attributes for a call. It may be called by a user to generate a schema for the call.

Overrides:
getRequiredAttributeNames in class IAPI
Returns:
a list containing the names of required attributes. This will be used to fetch attributes from a resource and build an attribute map, or just to validate that everything that we need is in the map.

Subclasses should override this and call super() to add attributes names to the list.


getOptionalAttributeNames

public java.util.Set getOptionalAttributeNames()
Deprecated. 
This is called by IAPI to get the required resources attributes for a call. It may be called by a user to generate a schema for the call.

Overrides:
getOptionalAttributeNames in class IAPI
Returns:
a list containing the names of optional attributes. This will be used to fetch attributes from a resource and build an attribute map. Subclasses should override this and call super() to add attribute names to the complete list.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
Deprecated. 
Throws:
java.lang.Exception