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

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

public interface RelationshipResource
extends ManageabilityCapability, XmlSerializable

RelationshipResource is the interface that describes WSDM relationships as WS-RF implied resources. Resources that use this capability represent the relationships that exist between other WS-resources in a system and should not, as a general rule, have any other significant state or interface.

Author:
Dan Jemiolo (danj)

Field Summary
static QName[] PROPERTIES
           
 
Method Summary
 void deleteProperty(QName property)
           
 EndpointReference getAccessEndpointReference()
           
 String getName()
           
 Participant[] getParticipant()
           
 Element[] getProperty(QName property)
           
 QName[] getPropertyNames()
          Concrete capability classes that define properties MUST override this method and provide the names of the properties.
 RelationshipType getType()
           
 void insertProperty(QName property, Element[] values)
           
 void setName(String name)
           
 void setParticipant(Participant[] participants)
           
 void setType(RelationshipType type)
           
 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
 
Methods inherited from interface org.apache.muse.util.xml.XmlSerializable
toXML, toXML
 

Field Detail

PROPERTIES

static final QName[] PROPERTIES
Method Detail

getAccessEndpointReference

EndpointReference getAccessEndpointReference()
                                             throws BaseFault
Returns:
The relationship resource's EPR - this should be the same value returned by Resource.getEndpointReference().
Throws:
BaseFault
See Also:
Resource.getEndpointReference()

getName

String getName()
               throws BaseFault
Returns:
A descriptive name for this relationship.
Throws:
BaseFault

getType

RelationshipType getType()
                         throws BaseFault
Returns:
The type of this relationship, as defined by an XSD complex type.
Throws:
BaseFault

getParticipant

Participant[] getParticipant()
                             throws BaseFault
Returns:
The participants in this relationship. The array will have a length of at least 2.
Throws:
BaseFault

setName

void setName(String name)
             throws BaseFault
Throws:
BaseFault

setType

void setType(RelationshipType type)
             throws BaseFault
Throws:
BaseFault

setParticipant

void setParticipant(Participant[] participants)
                    throws BaseFault
Parameters:
participants - The participants in this relationship. The array must have a length of at least 2.
Throws:
BaseFault

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.