MessageObjectProperty

Inheritance: java.lang.Object

public final class MessageObjectProperty

Represents a property on a MessageObject.

Constructors

Constructor Description
MessageObjectProperty(long propertyTag, int flags, Object value) Initializes a new instance of the MessageObjectProperty class.
MessageObjectProperty(int id, int type, int flags, Object value) Initializes a new instance of the MessageObjectProperty class.

Methods

Method Description
getPropertyType() Gets the type of the property.
getFlags() Gets the flags set on a property.
getId() Gets the id of the property.
getPropertyTag() Gets the property tag, a combined value which contains ``` Id ```(#getId) and ``` PropertyType ```(#getPropertyType)
getGuid() Gets or sets the GUID for the named property.
setGuid(UUID value) Gets or sets the GUID for the named property.
getPropertyKind() Gets or sets the kind of the property if it’s named.
setPropertyKind(int value) Gets or sets the kind of the property if it’s named.
getName() Gets or sets the name of the property if it’s named.
setName(String value) Gets or sets the name of the property if it’s named.
getNameId() Gets or sets the name id of the property if it’s named.
setNameId(long value) Gets or sets the name id of the property if it’s named.
getNamed() Gets a value indicating whether this MessageObjectProperty is a named property.
getAtomic() Gets a value indicating whether this MessageObjectProperty is atomic.
getValue() Gets or sets the value of the property.
setValue(Object value) Gets or sets the value of the property.
toInt() Converts the value of the property to integer.
toDateTime() Converts the value of the property to DateTime.
toStringRepresentation() Converts the value of the property to string.
toList() Converts the value of the property to a list of values.
toGuid() Converts the value of the property to ``` Guid ```(#getGuid/#setGuid(Guid)).

MessageObjectProperty(long propertyTag, int flags, Object value)

public MessageObjectProperty(long propertyTag, int flags, Object value)

Initializes a new instance of the MessageObjectProperty class.

Parameters:

Parameter Type Description
propertyTag long The property tag.
flags int The flags to be set on.
value java.lang.Object The value of the property.

MessageObjectProperty(int id, int type, int flags, Object value)

public MessageObjectProperty(int id, int type, int flags, Object value)

Initializes a new instance of the MessageObjectProperty class.

Parameters:

Parameter Type Description
id int The id.
type int The type of the property.
flags int The flags to be set on.
value java.lang.Object The value of the property.

getPropertyType()

public final int getPropertyType()

Gets the type of the property.

Value: The type of the property.

Returns: int

getFlags()

public final int getFlags()

Gets the flags set on a property.

Value: The flags.

Returns: int

getId()

public final int getId()

Gets the id of the property.

Value: The id if the property.

Returns: int

getPropertyTag()

public final long getPropertyTag()

Gets the property tag, a combined value which contains ``` Id ```(#getId) and ``` PropertyType ```(#getPropertyType)

Value: The property tag.

Returns: long

getGuid()

public final UUID getGuid()

Gets or sets the GUID for the named property.

Value: The GUID.

Returns: java.util.UUID

setGuid(UUID value)

public final void setGuid(UUID value)

Gets or sets the GUID for the named property.

Value: The GUID.

Parameters:

Parameter Type Description
value java.util.UUID

getPropertyKind()

public final int getPropertyKind()

Gets or sets the kind of the property if it’s named.

Value: The kind of the property.

Returns: int

setPropertyKind(int value)

public final void setPropertyKind(int value)

Gets or sets the kind of the property if it’s named.

Value: The kind of the property.

Parameters:

Parameter Type Description
value int

getName()

public final String getName()

Gets or sets the name of the property if it’s named.

Value: The name.

Returns: java.lang.String

setName(String value)

public final void setName(String value)

Gets or sets the name of the property if it’s named.

Value: The name.

Parameters:

Parameter Type Description
value java.lang.String

getNameId()

public final long getNameId()

Gets or sets the name id of the property if it’s named.

Value: The name id.

Returns: long

setNameId(long value)

public final void setNameId(long value)

Gets or sets the name id of the property if it’s named.

Value: The name id.

Parameters:

Parameter Type Description
value long

getNamed()

public final boolean getNamed()

Gets a value indicating whether this MessageObjectProperty is a named property.

Value: ``` true ``` if named; otherwise, ``` false ```.


A named property is determined by its ID, the range for such ids is [0x8000,0xfffe].

Returns: boolean

getAtomic()

public final boolean getAtomic()

Gets a value indicating whether this MessageObjectProperty is atomic.

Value: ``` true ``` if atomic; otherwise, ``` false ```.

Returns: boolean

getValue()

public final Object getValue()

Gets or sets the value of the property.

Returns: java.lang.Object

setValue(Object value)

public final void setValue(Object value)

Gets or sets the value of the property.

Parameters:

Parameter Type Description
value java.lang.Object

toInt()

public final int toInt()

Converts the value of the property to integer.

Returns: int - Integer value, if type can’t be converted to integer returns 0.

toDateTime()

public final Date toDateTime()

Converts the value of the property to DateTime.

Returns: java.util.Date - DateTime value, if type can’t be converted to DateTime returns java.util.Date#MinValue.


This method doesn’t provide automatic conversion of the data types, e.g. if ``` MessageObjectProperty.Value ```(#getValue/#setValue(Object)) property is of type default value will be returned.

toStringRepresentation()

public final String toStringRepresentation()

Converts the value of the property to string.

Returns: java.lang.String - String value, if type can’t be converted to string returns empty string.


This method doesn’t provide automatic conversion of the data types, e.g. if ``` MessageObjectProperty.Value ```(#getValue/#setValue(Object)) property is of type default value will be returned.

toList()

public System.Collections.IList toList()

Converts the value of the property to a list of values.

Returns: com.aspose.ms.System.Collections.IList - IList implementation, if type can’t be converted to IList returns empty list implementation.


This method doesn’t provide automatic conversion of the data types, e.g. if ``` MessageObjectProperty.Value ```(#getValue/#setValue(Object)) property is of type default value will be returned.

toGuid()

public final UUID toGuid()

Converts the value of the property to ``` Guid ```(#getGuid/#setGuid(Guid)).

Returns: java.util.UUID - Guid object, if type can’t be converted to Guid returns empty GUID.


This method doesn’t provide automatic conversion of the data types, e.g. if ``` MessageObjectProperty.Value ```(#getValue/#setValue(Object)) property is of type default value will be returned.