MSIObjectInfo Class Reference

#import <MSIObjectInfo.h>

Inheritance diagram for MSIObjectInfo:

Instance Methods
(id)	- initWithType:
(id)	- initWithType:subType:
(NSComparisonResult)	- compareElementName:
(NSComparisonResult)	- compareElementID:
(void)	- handleXml:attributes:support:
(id< MSTRHandler >)	- getXmlHandler
(void)	- handleXmlAttributes:attributes:
(void)	- loadFromXML:attributes:
(NSString *)	- getXml
(void)	- buildXml:
(void)	- buildXml:tagName:
(void)	- buildTypeSpecificXml:
(id)	- initWithContents:anID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:
(id)	- initWithContents:namedID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:

Class Methods
(MSIObjectInfo *)	+ newObject:
(ObjectSubTypes)	+ subTypeFromType:

Properties
NSString *	objectID
NSInteger	namedID
NSString *	name
NSString *	displayName
ObjectTypes	type
NSString *	sta
ObjectSubTypes	subType
NSInteger	accessGranted
NSInteger	viewMedia
NSInteger	availableViewMedia
NSString *	desc
NSString *	abbreviation
NSString *	iconPath
NSString *	owner
BOOL	isShortcut
NSString *	externalPath
NSInteger	externalObjectType
NSDate *	creationDate
NSDate *	modificationDate
int	binaryStatus
MSIObjectInfo *	parentFolder
NSString *	containerId
NSString *	containerType

Detailed Description

ObjectInfo is the base class of MicroStrategy object. It contains the object information, methods to serialize and deserialize these information.

Method Documentation

buildTypeSpecificXml:()

- (void) buildTypeSpecificXml:

(XMLBuilder *)

builder

Write special info of subclass to xml. Subclass should overwrite this method if it has more information.

Parameters

builder

xml builder

buildXml:()

- (void) buildXml:

(XMLBuilder *)

builder

Write the object info to xml format. It will add tag for the object depending on the type.

See also

- buildXml:tagName

Parameters

builder

xml builder

buildXml:tagName:()

- (void) buildXml:		(XMLBuilder *)	builder
tagName:		(NSString *)	tagName

Write the object info to xml format. It will add tag for the object.

Parameters

builder	xml builder
tagName	xml tag name for the object

compareElementID:()

- (NSComparisonResult) compareElementID:

(MSIObjectInfo *)

object

Compare the object ID with another object. The ID are compared with numeric order, case insensitive.

Parameters

object

object to be compared

Returns

NSOrderedAscending if the ID is smaller than the ID to be compared NSOrderedSame if the two objects has the same ID NSOrderedDecending if the ID is larger than the ID to be compared

See also

ObjectInfo

compareElementName:()

- (NSComparisonResult) compareElementName:

(MSIObjectInfo *)

object

Compare the object name with another object. The names are compared with numeric order, case insensitive.

Parameters

object

object to be compared

Returns

NSOrderedAscending if the name is smaller than the name to be compared NSOrderedSame if the two objects has the same name NSOrderedDecending if the name is larger than the name to be compared

See also

ObjectInfo

getXml()

- (NSString*) getXml

Get the xml string of this object info

Returns

object info xml representation

getXmlHandler()

- (id<MSTRHandler>) getXmlHandler

Get the handler which can parse the ObjectInfo xml. Subclass should implement this method to return the appropriate handler if subclass have more content in xml.

Returns

MSTRHandler xml handler

handleXml:attributes:support:()

- (void) handleXml:		(NSString *)	elementName
attributes:		(NSDictionary *)	attributes
support:		(SAXSupport *)	support

Read the object info from xml

Parameters

elementName	xml element name
attributes	attributes of this element
support	XML SAX parser

handleXmlAttributes:attributes:()

- (void) handleXmlAttributes:		(NSString *)	elementName
attributes:		(NSDictionary *)	attributes

Read attributes of this element to object info. If subclass has more attributes, it needs to overwrite this method.

Parameters

elementName	xml element name
attributes	attributes of this element

initWithContents:anID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:()

- (id) initWithContents:		(NSString *)	nm
anID:		(NSString *)	did
aDesc:		(NSString *)	d
aType:		(ObjectTypes)	tp
aSubtype:		(ObjectSubTypes)	subtp
anAbbrev:		(NSString *)	abbr
isShortcut:		(BOOL)	shortcut
iconPath:		(NSString *)	_iconPath

Initializer with object information

initWithContents:namedID:aDesc:aType:aSubtype:anAbbrev:isShortcut:iconPath:()

- (id) initWithContents:		(NSString *)	nm
namedID:		(NSInteger)	_namedID
aDesc:		(NSString *)	d
aType:		(ObjectTypes)	tp
aSubtype:		(ObjectSubTypes)	subtp
anAbbrev:		(NSString *)	abbr
isShortcut:		(BOOL)	shortcut
iconPath:		(NSString *)	_iconPath

Intializer with named object information

initWithType:()

- (id) initWithType:

(ObjectTypes)

_type

Initializer a ObjectInfo with type. Subtype will default to 0. If the type doesn't have different subtypes, the subtype will also be initialized.

Parameters

_type

one of the ObjectTypes in enums.h

Returns

ObjectInfo

See also

ObjectTypes

initWithType:subType:()

- (id) initWithType:		(ObjectTypes)	_type
subType:		(ObjectSubTypes)	_subType

Initializer a ObjectInfo with type and subtype

Parameters

_type	one of the ObjectTypes in enums.h
_subType	one of the ObjectSubTypes in enums.h

Returns

ObjectInfo

See also

ObjectTypes

loadFromXML:attributes:()

- (void) loadFromXML:		(NSString *)	elementName
attributes:		(NSDictionary *)	attributes

Load attributs of this element to object info. It has the same functionality as handleXMLAttributes.

Parameters

elementName	xml element name
attributes	attributes of this element

newObject:()

+ (MSIObjectInfo*) newObject:

(ObjectTypes)

type

Static method to create a ObjectInfo

Parameters

type	object type

Returns

Folder if the object type is ObjectTypeFolder, otherwise, return the base class

subTypeFromType:()

+ (ObjectSubTypes) subTypeFromType:

(ObjectTypes)

type

Get subtype from type. It only works if the type doesn't have different subtypes, or it returns 0.

Parameters

type	object type
object	subtype

Property Documentation

abbreviation

- (NSString *) abbreviation

readwritenonatomiccopy

object abbreviation

accessGranted

- (NSInteger) accessGranted

readwriteatomic

Access right granted on this object for the login user The value can be the combination of AccessRightFlags.

availableViewMedia

- (NSInteger) availableViewMedia

readwriteatomic

binaryStatus

- (int) binaryStatus

readwritenonatomicassign

Binary status. For webdav folder and webdav file

containerId

- (NSString*) containerId

readwritenonatomicstrong

containerType

- (NSString*) containerType

readwritenonatomicstrong

creationDate

- (NSDate*) creationDate

readwritenonatomicstrong

object creation date

desc

- (NSString *) desc

readwritenonatomiccopy

object description

displayName

- (NSString *) displayName

readwritenonatomiccopy

object display name

externalObjectType

- (NSInteger) externalObjectType

readwritenonatomicassign

externalPath

- (NSString*) externalPath

readwritenonatomiccopy

path to the resource of the external object

iconPath

- (NSString *) iconPath

readwritenonatomiccopy

icon path of this object

isShortcut

- (BOOL) isShortcut

readwritenonatomicassign

Whether this object is a shortcut.

modificationDate

- (NSDate*) modificationDate

readwritenonatomicstrong

last modification date

name

- (NSString *) name

readwritenonatomiccopy

object name

namedID

- (NSInteger) namedID

readwritenonatomicassign

This member is added to support representing a named folder with an ObjectInfo, it is NOT serialized to XML, however it is saved in archive (NSCoding) and copied over (NSCopying). The default value is negative one (-1) which represents invalid named ID.

ID of named folder

objectID

- (NSString *) objectID

readwritenonatomiccopy

ID of this object. It's unique within a MicroStrategy project.

owner

- (NSString *) owner

readwritenonatomiccopy

Owner of this object. It's the user's name who created this object.

parentFolder

- (MSIObjectInfo *) parentFolder

readwritenonatomicstrong

sta

- (NSString *) sta

readwritenonatomiccopy

subType

- (ObjectSubTypes) subType

readwriteatomic

object subtype

type

- (ObjectTypes) type

readwriteatomic

object type

viewMedia

- (NSInteger) viewMedia

readwriteatomic

View mode of this object.