org.yawlfoundation.yawl.elements
Class YAWLServiceReference

java.lang.Object
  extended by org.yawlfoundation.yawl.authentication.YClient
      extended by org.yawlfoundation.yawl.elements.YAWLServiceReference
All Implemented Interfaces:
YVerifiable

public class YAWLServiceReference
extends YClient
implements YVerifiable

Represents a server-side reference to a YAWL Custom Service.

Since:
0.1
Author:
Lachlan Aldred, Michael Adams (for 2.0-2.1)
Created/Last Date:
18/03/2004

Field Summary
 
Fields inherited from class org.yawlfoundation.yawl.authentication.YClient
_documentation, _password, _userName
 
Constructor Summary
YAWLServiceReference()
          Constructs and empty service reference (default constructor).
YAWLServiceReference(String serviceID, YAWLServiceGateway webGateway)
           
YAWLServiceReference(String serviceID, YAWLServiceGateway webGateway, String serviceName)
           
YAWLServiceReference(String serviceID, YAWLServiceGateway webGateway, String serviceName, String servicePassword)
           
YAWLServiceReference(String serviceID, YAWLServiceGateway webGateway, String serviceName, String servicePassword, String doco)
           
 
Method Summary
 boolean canBeAssignedToTask()
           
 boolean equals(Object other)
           
 void fromXML(String xml)
           
 boolean get_assignable()
           
 String get_documentation()
           
 String get_serviceName()
           
 String get_servicePassword()
           
 String get_yawlServiceID()
           
 String getScheme()
          Returns the scheme (i.e.
 String getServiceID()
           
 String getServiceName()
           
 String getServicePassword()
           
 String getURI()
           
 int hashCode()
           
 boolean isAssignable()
           
 void set_assignable(boolean b)
           
 void set_documentation(String id)
           
 void set_serviceName(String name)
           
 void set_servicePassword(String password)
           
 void set_yawlServiceID(String id)
           
 void setAssignable(boolean b)
           
 void setServiceName(String name)
           
 void setServicePassword(String password)
           
 String toXML()
           
 String toXMLComplete()
           
static YAWLServiceReference unmarshal(String serialisedService)
          Returns a YAWL service from XML (if valid).
 List<YVerificationMessage> verify()
          Internally verify the object against YAWL language semantics and report any errors and/or warnings.
 
Methods inherited from class org.yawlfoundation.yawl.authentication.YClient
getDocumentation, getPassword, getUserName, setDocumentation, setPassword, setUserName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

YAWLServiceReference

public YAWLServiceReference()
Constructs and empty service reference (default constructor).


YAWLServiceReference

public YAWLServiceReference(String serviceID,
                            YAWLServiceGateway webGateway)

YAWLServiceReference

public YAWLServiceReference(String serviceID,
                            YAWLServiceGateway webGateway,
                            String serviceName)

YAWLServiceReference

public YAWLServiceReference(String serviceID,
                            YAWLServiceGateway webGateway,
                            String serviceName,
                            String servicePassword)

YAWLServiceReference

public YAWLServiceReference(String serviceID,
                            YAWLServiceGateway webGateway,
                            String serviceName,
                            String servicePassword,
                            String doco)
Method Detail

getServiceID

public String getServiceID()

getServiceName

public String getServiceName()

setServiceName

public void setServiceName(String name)

getServicePassword

public String getServicePassword()

setServicePassword

public void setServicePassword(String password)

setAssignable

public void setAssignable(boolean b)

isAssignable

public boolean isAssignable()

canBeAssignedToTask

public boolean canBeAssignedToTask()

getURI

public String getURI()

set_yawlServiceID

public void set_yawlServiceID(String id)

get_yawlServiceID

public String get_yawlServiceID()

set_documentation

public void set_documentation(String id)

get_documentation

public String get_documentation()

get_serviceName

public String get_serviceName()

set_serviceName

public void set_serviceName(String name)

get_servicePassword

public String get_servicePassword()

set_servicePassword

public void set_servicePassword(String password)

set_assignable

public void set_assignable(boolean b)

get_assignable

public boolean get_assignable()

equals

public boolean equals(Object other)
Overrides:
equals in class YClient

hashCode

public int hashCode()
Overrides:
hashCode in class YClient

verify

public List<YVerificationMessage> verify()
Description copied from interface: YVerifiable
Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Specified by:
verify in interface YVerifiable
Returns:
a List of YVerificationMessage objects
See Also:
YVerificationMessage

toXML

public String toXML()
Overrides:
toXML in class YClient

toXMLComplete

public String toXMLComplete()

fromXML

public void fromXML(String xml)

unmarshal

public static YAWLServiceReference unmarshal(String serialisedService)
Returns a YAWL service from XML (if valid).

Parameters:
serialisedService -
Returns:
an instantiated YAWL Service, or null if the XML was invalid

getScheme

public String getScheme()
Returns the scheme (i.e. the protocol) component of the URI (assuming standard URI format). If no protocol defined, null is returned.

Returns:
The scheme component of the URI


Copyright © 2004-2012 The YAWL Foundation.