uk.ac.cam.ucs.ibis.dto

Class IbisAttribute

java.lang.Object

uk.ac.cam.ucs.ibis.dto.IbisAttribute

public class IbisAttribute
extends Object

Class representing an attribute of a person or institution returned by the web service API. Note that for institution attributes, the instid, visibility and owningGroupid fields will be null.

Field Summary

Fields

Modifier and Type	Field and Description
Long	attrid The unique internal identifier of the attribute.
byte[]	binaryData The binary data held in the attribute (e.g., a JPEG photo).
String	comment Any comment associated with the attribute.
Date	effectiveFrom For time-limited attributes, the date from which it takes effect.
Date	effectiveTo For time-limited attributes, the date after which it is no longer effective.
String	instid For a person attribute, the optional institution that the attribute is associated with.
String	owningGroupid For a person attribute, the ID of the group that owns it (typically the user agent group that created it).
String	scheme The attribute's scheme.
String	value The attribute's value (except for binary attributes).
String	visibility For a person attribute, it's visibility ("private", "institution", "university" or "world").

Constructor Summary

Constructors

Constructor and Description
IbisAttribute()

Method Summary

Modifier and Type	Method and Description
String	encodedString() Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method.
static IbisAttribute	valueOf(String encodedStr) Create an IbisAttribute from its ASCII encoded string representation.

Methods inherited from class java.lang.Object

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

Field Detail

attrid

public Long attrid

The unique internal identifier of the attribute.

scheme

public String scheme

The attribute's scheme.

value

public String value

The attribute's value (except for binary attributes).

binaryData

public byte[] binaryData

The binary data held in the attribute (e.g., a JPEG photo).

comment

public String comment

Any comment associated with the attribute.

instid

public String instid

For a person attribute, the optional institution that the attribute is associated with. This will not be set for institution attributes.

visibility

public String visibility

For a person attribute, it's visibility ("private", "institution", "university" or "world"). This will not be set for institution attributes.

effectiveFrom

public Date effectiveFrom

For time-limited attributes, the date from which it takes effect.

effectiveTo

public Date effectiveTo

For time-limited attributes, the date after which it is no longer effective.

owningGroupid

public String owningGroupid

For a person attribute, the ID of the group that owns it (typically the user agent group that created it).

Constructor Detail

IbisAttribute

public IbisAttribute()

Method Detail

encodedString

public String encodedString()

Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method. This string is compatible with valueOf(java.lang.String).

NOTE: This requires that the attribute's scheme field be set, and typically the value or binaryData should also be set.

Returns:

The string encoding of this attribute.

valueOf

public static IbisAttribute valueOf(String encodedStr)
    throws ParseException

Create an IbisAttribute from its ASCII encoded string representation. This allows an IbisAttribute to be used as a parameter in a web service API method.

Parameters:

encodedStr - The ASCII string encoding of the attribute, as produced by encodedString().

Returns:

The IbisAttribute constructed from the string.

Throws:

ParseException