PWStructure Class Reference
Inherits from | NSObject |
Conforms to | NSCoding NSCopying |
Declared in | PWStructure.h |
Overview
PWStructure
items are used to build the structure and hierarchy of the data. Each structure item that is defined as an object can also optionally be assigned a schema that defines what content can be saved to those structure items. All values in a PWStructure
object are immutable on the client. You can modify PWStructure
values in MaaS Portal. PWStructure
conforms to the NSCoding
and NSCopying
protocol.
Tasks
Other Methods
-
structureID
An integer that is used to identify the structure ID.
property -
parentID
An integer that is used to identify the parent ID.
property -
containerID
A string that is used to identify the container ID.
property -
schemaID
A string that is used to identify the schema ID.
property -
name
A string that is used to identify the structure name.
property -
type
A string that is used to identify the structure type.
property -
field
A string that is used to identify the structure field.
property -
structureDescription
A string that is used to identify the structure name.
property -
sortOrder
An unsigned integer that is used to identify the structure name.
property -
isActive
An boolean that is used to identify the parent ID.
property -
creationDate
The creation date of the structure.
property -
lastUpdated
The last update date for the structure.
property -
schema
The
propertyPWSchema
object associated with the current structure, if one exists. -
content
The content, where the structure is based on the associated
propertyPWSchema
. -
children
Depending on the API method, the child
propertyPWStructure
items may be return as well.
Convenience
-
+ unpack:
Convenience method to instantiate a
PWStructure
object from a properly formattedNSDictionary
object. -
– dictionary
Returns an
NSDictionary
representation of the current structure.
Properties
children
Depending on the API method, the child PWStructure
items may be return as well.
@property (nonatomic, readonly) NSArray *children
Declared In
PWStructure.h
containerID
A string that is used to identify the container ID.
@property (nonatomic, readonly) NSString *containerID
Declared In
PWStructure.h
content
The content, where the structure is based on the associated PWSchema
.
@property (nonatomic, readonly) NSDictionary *content
Declared In
PWStructure.h
creationDate
The creation date of the structure.
@property (nonatomic, readonly) NSDate *creationDate
Declared In
PWStructure.h
field
A string that is used to identify the structure field.
@property (nonatomic, readonly) NSString *field
Declared In
PWStructure.h
isActive
An boolean that is used to identify the parent ID.
@property (nonatomic, readonly) BOOL isActive
Declared In
PWStructure.h
lastUpdated
The last update date for the structure.
@property (nonatomic, readonly) NSDate *lastUpdated
Declared In
PWStructure.h
name
A string that is used to identify the structure name.
@property (nonatomic, readonly) NSString *name
Declared In
PWStructure.h
parentID
An integer that is used to identify the parent ID.
@property (nonatomic, readonly) NSUInteger parentID
Declared In
PWStructure.h
schema
The PWSchema
object associated with the current structure, if one exists.
@property (nonatomic, readonly) PWSchema *schema
Declared In
PWStructure.h
schemaID
A string that is used to identify the schema ID.
@property (nonatomic, readonly) NSString *schemaID
Declared In
PWStructure.h
sortOrder
An unsigned integer that is used to identify the structure name.
@property (nonatomic, readonly) NSUInteger sortOrder
Declared In
PWStructure.h
structureDescription
A string that is used to identify the structure name.
@property (nonatomic, readonly) NSString *structureDescription
Declared In
PWStructure.h
Class Methods
unpack:
Convenience method to instantiate a PWStructure
object from a properly formatted NSDictionary
object.
+ (instancetype)unpack:(NSDictionary *)dictionary
Parameters
- dictionary
The dictionary from which to instantiate the
PWStructure
object.
Declared In
PWStructure.h