org.yawlfoundation.yawl.elements

Class YAWLServiceReference

java.lang.Object

org.yawlfoundation.yawl.authentication.YClient

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

Constructors

Constructor and Description
YAWLServiceReference() Constructs and empty service reference (default constructor).
YAWLServiceReference(java.lang.String serviceID, YAWLServiceGateway webGateway)
YAWLServiceReference(java.lang.String serviceID, YAWLServiceGateway webGateway, java.lang.String serviceName)
YAWLServiceReference(java.lang.String serviceID, YAWLServiceGateway webGateway, java.lang.String serviceName, java.lang.String servicePassword)
YAWLServiceReference(java.lang.String serviceID, YAWLServiceGateway webGateway, java.lang.String serviceName, java.lang.String servicePassword, java.lang.String doco)

Method Summary

Modifier and Type	Method and Description
boolean	canBeAssignedToTask()
boolean	equals(java.lang.Object other)
void	fromXML(java.lang.String xml)
boolean	get_assignable()
java.lang.String	get_documentation()
java.lang.String	get_serviceName()
java.lang.String	get_servicePassword()
java.lang.String	get_yawlServiceID()
java.lang.String	getScheme() Returns the scheme (i.e.
java.lang.String	getServiceID()
java.lang.String	getServiceName()
java.lang.String	getServicePassword()
java.lang.String	getURI()
int	hashCode()
boolean	isAssignable()
void	set_assignable(boolean b)
void	set_documentation(java.lang.String id)
void	set_serviceName(java.lang.String name)
void	set_servicePassword(java.lang.String password)
void	set_yawlServiceID(java.lang.String id)
void	setAssignable(boolean b)
void	setServiceName(java.lang.String name)
void	setServicePassword(java.lang.String password)
java.lang.String	toXML()
java.lang.String	toXMLComplete()
static YAWLServiceReference	unmarshal(java.lang.String serialisedService) Returns a YAWL service from XML (if valid).
void	verify(YVerificationHandler handler) 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(java.lang.String serviceID,
                            YAWLServiceGateway webGateway)

YAWLServiceReference

public YAWLServiceReference(java.lang.String serviceID,
                            YAWLServiceGateway webGateway,
                            java.lang.String serviceName)

YAWLServiceReference

public YAWLServiceReference(java.lang.String serviceID,
                            YAWLServiceGateway webGateway,
                            java.lang.String serviceName,
                            java.lang.String servicePassword)

YAWLServiceReference

public YAWLServiceReference(java.lang.String serviceID,
                            YAWLServiceGateway webGateway,
                            java.lang.String serviceName,
                            java.lang.String servicePassword,
                            java.lang.String doco)

Method Detail

getServiceID

public java.lang.String getServiceID()

getServiceName

public java.lang.String getServiceName()

setServiceName

public void setServiceName(java.lang.String name)

getServicePassword

public java.lang.String getServicePassword()

setServicePassword

public void setServicePassword(java.lang.String password)

setAssignable

public void setAssignable(boolean b)

isAssignable

public boolean isAssignable()

canBeAssignedToTask

public boolean canBeAssignedToTask()

getURI

public java.lang.String getURI()

set_yawlServiceID

public void set_yawlServiceID(java.lang.String id)

get_yawlServiceID

public java.lang.String get_yawlServiceID()

set_documentation

public void set_documentation(java.lang.String id)

get_documentation

public java.lang.String get_documentation()

get_serviceName

public java.lang.String get_serviceName()

set_serviceName

public void set_serviceName(java.lang.String name)

get_servicePassword

public java.lang.String get_servicePassword()

set_servicePassword

public void set_servicePassword(java.lang.String password)

set_assignable

public void set_assignable(boolean b)

get_assignable

public boolean get_assignable()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class YClient

hashCode

public int hashCode()

Overrides:

hashCode in class YClient

verify

public void verify(YVerificationHandler handler)

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

See Also:

YVerificationMessage

toXML

public java.lang.String toXML()

Overrides:

toXML in class YClient

toXMLComplete

public java.lang.String toXMLComplete()

fromXML

public void fromXML(java.lang.String xml)

unmarshal

public static YAWLServiceReference unmarshal(java.lang.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 java.lang.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