ObjectiveCMIS/Common/CMISPropertyData.h

/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
 */
 
#import <Foundation/Foundation.h>
#import "CMISEnums.h"
#import "CMISExtensionData.h"

@interface CMISPropertyData : CMISExtensionData

@property (nonatomic, strong) NSString *identifier;
@property (nonatomic, strong) NSString *localName;
@property (nonatomic, strong) NSString *displayName;
@property (nonatomic, strong) NSString *queryName;

@property CMISPropertyType type;

// Returns the list of values of this property. 
// For a single value property this is a list with one entry
@property (nonatomic, copy) NSArray *values;

// Returns the first entry of the list of values.
@property (nonatomic, assign, readonly) id firstValue;

/** Convenience method for retrieving the string value. Returns nil if property is not of string type */
- (NSString *)propertyStringValue;

/** Convenience method for retrieving the integer value. Returns nil if property is not of integer type */
- (NSNumber *)propertyIntegerValue;

/** Convenience method for retrieving the id value. Returns nil if property is not of id type */
- (NSString *)propertyIdValue;

/** Convenience method for retrieving the datetime value. Returns nil if property is not of datetime type */
- (NSDate *)propertyDateTimeValue;

/** Convenience method for retrieving the boolean value. Returns nil if property is not of boolean type */
- (NSNumber *)propertyBooleanValue;

/** Convenience method for retrieving the decimal value. Returns nil if property is not of decimal type */
- (NSNumber *)propertyDecimalValue;

/** Creation of a multi-value property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id arrayValue:(NSArray *)value type:(CMISPropertyType)type;

/** Creation of a string property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id stringValue:(NSString *)value;

/** Creation of an integer property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id integerValue:(NSInteger)value;

/** Creation of a decimal property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id decimalValue:(NSNumber *)value;

/** Creation of an id property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id idValue:(NSString *)value;

/** Creation of a datetime property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id dateTimeValue:(NSDate *)value;

/** Creation of a boolean property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id boolValue:(BOOL)value;

/** Creation of a uri property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id uriValue:(NSURL *)value;

/** Creation of a uri property 
 */
+ (CMISPropertyData *)createPropertyForId:(NSString *)id htmlValue:(NSString *)value;

@end