nu.dll.lyskom
Class AuxItem

java.lang.Object
  |
  +--nu.dll.lyskom.AuxItem

All Implemented Interfaces:

java.io.Serializable, Tokenizable

public class AuxItem

extends java.lang.Object

implements java.io.Serializable, Tokenizable

Aux-Item, a LysKOM data type introduced in version 10. An Aux-Item can be attached to a conference or a text, tagging it with information otherwise not covered by the protocol. LatteKOM has limited, but existing, support for Aux-Items.

See Also:

Serialized Form

Field Summary

static int	flagDeleted
static int	flagDontGarb
static int	flagHideCreator
static int	flagInherit
static int	flagReserved2
static int	flagReserved3
static int	flagReserved4
static int	flagSecret
static int	ITEM_SIZE
static int	tagContentType
static int	tagCreatingSoftware
static int	tagCrossReference
static int	tagFaqText
static int	tagFastReply
static int	tagMxAuthor
static int	tagMxCc
static int	tagMxDate
static int	tagMxFrom
static int	tagMxInReplyTo
static int	tagMxMessageId
static int	tagMxMimePartIn
static int	tagMxMisc
static int	tagMxReplyTo
static int	tagMxTo
static int	tagNoComments
static int	tagPersonalComment

Constructor Summary

AuxItem(int tag, nu.dll.lyskom.Bitstring flags, int inheritLimit, nu.dll.lyskom.Hollerith data)
Constructor used to create new AuxItem objects for RPC calls.

AuxItem(int no, int tag, int creator, nu.dll.lyskom.KomTime createdAt, nu.dll.lyskom.Bitstring flags, int inheritLimit, nu.dll.lyskom.Hollerith data)
Constructor used to create new AuxItem objects for RPC calls.

Method Summary

static int	countAuxItems(nu.dll.lyskom.AuxItem[] auxItems) Counts the number of AuxItems in an array, skipping null entries.
nu.dll.lyskom.KomTime	getCreatedAt() Returns the time at which this Aux-Item was created.
int	getCreator() Returns this Aux-Item's creator.
nu.dll.lyskom.Hollerith	getData() Returns the data contained in this Aux-Item
java.lang.String	getDataString() Returns the data as a String, translated according to Hollerith.getContentString()
int	getInheritLimit() Returns the inheritance limit for this Aux-Item.
int	getNo() Returns this specific Aux-Item's number.
int	getTag() Returns this Aux-Item's tag.
java.lang.String	toString()
nu.dll.lyskom.KomToken	toToken() Uses the data in this AuxItem object to construct an Aux-Item-Input token that can be used in RPC calls to the servern.

Methods inherited from class java.lang.Object

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

Field Detail

tagContentType

public static final int tagContentType

See Also:

Constant Field Values

tagFastReply

public static final int tagFastReply

See Also:

Constant Field Values

tagCrossReference

public static final int tagCrossReference

See Also:

Constant Field Values

tagNoComments

public static final int tagNoComments

See Also:

Constant Field Values

tagPersonalComment

public static final int tagPersonalComment

See Also:

Constant Field Values

tagFaqText

public static final int tagFaqText

See Also:

Constant Field Values

tagCreatingSoftware

public static final int tagCreatingSoftware

See Also:

Constant Field Values

tagMxAuthor

public static final int tagMxAuthor

See Also:

Constant Field Values

tagMxFrom

public static final int tagMxFrom

See Also:

Constant Field Values

tagMxReplyTo

public static final int tagMxReplyTo

See Also:

Constant Field Values

tagMxTo

public static final int tagMxTo

See Also:

Constant Field Values

tagMxCc

public static final int tagMxCc

See Also:

Constant Field Values

tagMxDate

public static final int tagMxDate

See Also:

Constant Field Values

tagMxMessageId

public static final int tagMxMessageId

See Also:

Constant Field Values

tagMxInReplyTo

public static final int tagMxInReplyTo

See Also:

Constant Field Values

tagMxMisc

public static final int tagMxMisc

See Also:

Constant Field Values

tagMxMimePartIn

public static final int tagMxMimePartIn

See Also:

Constant Field Values

flagDeleted

public static final int flagDeleted

See Also:

Constant Field Values

flagInherit

public static final int flagInherit

See Also:

Constant Field Values

flagSecret

public static final int flagSecret

See Also:

Constant Field Values

flagHideCreator

public static final int flagHideCreator

See Also:

Constant Field Values

flagDontGarb

public static final int flagDontGarb

See Also:

Constant Field Values

flagReserved2

public static final int flagReserved2

See Also:

Constant Field Values

flagReserved3

public static final int flagReserved3

See Also:

Constant Field Values

flagReserved4

public static final int flagReserved4

See Also:

Constant Field Values

ITEM_SIZE

public static final int ITEM_SIZE

See Also:

Constant Field Values

Constructor Detail

AuxItem

public AuxItem(int tag,
               nu.dll.lyskom.Bitstring flags,
               int inheritLimit,
               nu.dll.lyskom.Hollerith data)

Constructor used to create new AuxItem objects for RPC calls.

AuxItem

public AuxItem(int no,
               int tag,
               int creator,
               nu.dll.lyskom.KomTime createdAt,
               nu.dll.lyskom.Bitstring flags,
               int inheritLimit,
               nu.dll.lyskom.Hollerith data)

Constructor used to create new AuxItem objects for RPC calls.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNo

public int getNo()

Returns this specific Aux-Item's number. An Aux-Item's number, in combination with a text och conference number, is what uniquely identifies that particular Aux-Item. Thus, the Aux-Item numbers for a given text is ever incrementing has the Aux-Items are updated/changed.

getTag

public int getTag()

Returns this Aux-Item's tag.

getCreator

public int getCreator()

Returns this Aux-Item's creator.

getCreatedAt

public nu.dll.lyskom.KomTime getCreatedAt()

Returns the time at which this Aux-Item was created.

getInheritLimit

public int getInheritLimit()

Returns the inheritance limit for this Aux-Item.

getData

public nu.dll.lyskom.Hollerith getData()

Returns the data contained in this Aux-Item

getDataString

public java.lang.String getDataString()

Returns the data as a String, translated according to Hollerith.getContentString()

See Also:

Hollerith.getContentString()

toToken

public nu.dll.lyskom.KomToken toToken()

Uses the data in this AuxItem object to construct an Aux-Item-Input token that can be used in RPC calls to the servern.

Specified by:

toToken in interface Tokenizable

countAuxItems

public static int countAuxItems(nu.dll.lyskom.AuxItem[] auxItems)

Counts the number of AuxItems in an array, skipping null entries.