org.apache.muse.ws.dm.muws
Interface State

All Superinterfaces:
Capability, Initialization, InitializationParameters, ManageabilityCapability, Shutdown, WsResourceCapability
All Known Implementing Classes:
SimpleState

public interface State
extends ManageabilityCapability

This interface represents the WSDM State capability. It defines two properties, muws2:State and muws2:StateTransition, which are the resource's current state and the record of its last state change, respectively.

Unlike OperationalStatus, which provides an enumeration of status values, the state types are not standard - the implementation must define them using XML Schema and the StateType interface.

Author:
Dan Jemiolo (danj)

Field Summary
static QName[] PROPERTIES
           
 
Method Summary
 void deleteProperty(QName property)
           
 Element[] getProperty(QName property)
           
 QName[] getPropertyNames()
          Concrete capability classes that define properties MUST override this method and provide the names of the properties.
 StateType getState()
           
 StateTransition getStateTransition()
           
 void insertProperty(QName property, Element[] values)
           
 void setState(StateType state)
           
 void updateProperty(QName property, Element[] values)
           
 
Methods inherited from interface org.apache.muse.ws.resource.WsResourceCapability
getWsResource
 
Methods inherited from interface org.apache.muse.core.Capability
getActions, getCapabilityURI, getEnvironment, getLog, getMessageHandler, getPersistence, getResource, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setLog, setMessageHandlers, setPersistence, setResource
 
Methods inherited from interface org.apache.muse.core.Initialization
hasBeenInitialized, initialize
 
Methods inherited from interface org.apache.muse.core.InitializationParameters
getInitializationParameter, getInitializationParameters, setInitializationParameters
 
Methods inherited from interface org.apache.muse.core.Shutdown
hasBeenShutdown, shutdown
 

Field Detail

PROPERTIES

static final QName[] PROPERTIES
Method Detail

getState

StateType getState()
                   throws BaseFault
Returns:
The current state of the owning resource; state types may have subtypes, and these values should be considered when evaluating the state.
Throws:
BaseFault

getStateTransition

StateTransition getStateTransition()
                                   throws BaseFault
Returns:
The record of the last state change experienced by the owning resource.
Throws:
BaseFault

setState

void setState(StateType state)
              throws BaseFault
Parameters:
state - The current state of the owning resource; this state may have subtypes. Changing the State will alter the muws2:StateTransition property as well.
Throws:
BaseFault -
  • If the state type is not a valid value (as specified in the resource's RMD).
  • If the proposed state-to-state transition is not allowed.

deleteProperty

void deleteProperty(QName property)
                    throws BaseFault
Throws:
BaseFault

getProperty

Element[] getProperty(QName property)
                      throws BaseFault
Throws:
BaseFault

getPropertyNames

QName[] getPropertyNames()
Concrete capability classes that define properties MUST override this method and provide the names of the properties.

Returns:
The names of the resource properties defined by this capability.

insertProperty

void insertProperty(QName property,
                    Element[] values)
                    throws BaseFault
Throws:
BaseFault

updateProperty

void updateProperty(QName property,
                    Element[] values)
                    throws BaseFault
Throws:
BaseFault


Copyright © 2005-2011 Apache Web Services - Muse. All Rights Reserved.