org.ands.rifcs.base

Class Electronic

java.lang.Object

org.ands.rifcs.base.RIFCSElement

org.ands.rifcs.base.Electronic

public class Electronic
extends RIFCSElement

Class representing a RIF-CS electronic address object.

Author:

Scott Yeadon

Method Summary

Methods

Modifier and Type	Method and Description
void	addArg(Arg arg) Add an argument to the electronic address object.
void	addArg(java.lang.String name, java.lang.String required, java.lang.String type, java.lang.String use) Add an argument to the electroinc address object.
java.util.List<Arg>	getArgs() Obtain the arguments for this electronic address.
java.lang.String	getType() return the type.
java.lang.String	getValue() Return the electronic address URI.
Arg	newArg() Create and return an empty Arg object.
void	setType(java.lang.String type) Set the type.
void	setValue(java.lang.String valueUri) Set the electronic address URI.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setType

public final void setType(java.lang.String type)

Set the type.

Parameters:

type - The electronic address type

getType

public final java.lang.String getType()

return the type.

Returns:

The type attribute value or empty string if attribute is empty or not present

newArg

public final Arg newArg()
                 throws RIFCSException

Create and return an empty Arg object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.

Returns:

the new Arg object

Throws:

RIFCSException - A RIFCSException

addArg

public final void addArg(java.lang.String name,
          java.lang.String required,
          java.lang.String type,
          java.lang.String use)
                  throws RIFCSException

Add an argument to the electroinc address object.

Parameters:

name - the name of the argument

required - true if the argument is required else false

type - the argument type

use - the argument use

Throws:

RIFCSException - A RIFCSException

getArgs

public final java.util.List<Arg> getArgs()

Obtain the arguments for this electronic address.

Returns:

A list of Arg objects

addArg

public final void addArg(Arg arg)

Add an argument to the electronic address object.

Parameters:

arg - a completed Arg object

setValue

public final void setValue(java.lang.String valueUri)

Set the electronic address URI.

Parameters:

valueUri - a resolvable URI representing the electronic address of the containing registry object

getValue

public final java.lang.String getValue()

Return the electronic address URI.

Returns:

a resolvable URI representing the electronic address of the containing registry object