ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros | Typedefs | Enumerations
lis_datatypes.h File Reference

Go to the source code of this file.

Macros

#define LIS_DCTERMS_NAMESPACE_PREFIX   "dcterms"
 
#define LIS_OSLC_CM_CORE_NAMESPACE_PREFIX   "oslc_cm"
 
#define LIS_OSLC_CORE_NAMESPACE_PREFIX   "oslc"
 
#define LIS_OSLC_DATA_NAMESPACE_PREFIX   "oslc_data"
 
#define LIS_RDF_NAMESPACE_PREFIX   "rdf"
 
#define LIS_RDFS_NAMESPACE_PREFIX   "rdfs"
 

Typedefs

typedef enum LIS_media_type_e LIS_media_type_t
 
typedef enum
LIS_properties_prefix_name_e 
LIS_properties_prefix_name_t
 
typedef enum
LIS_properties_range_type_e 
LIS_properties_range_type_t
 
typedef enum
LIS_properties_representation_type_e 
LIS_properties_representation_type_t
 
typedef enum
LIS_properties_value_occurs_e 
LIS_properties_value_occurs_t
 
typedef enum
LIS_properties_value_type_e 
LIS_properties_value_type_t
 

Enumerations

enum  LIS_media_type_e {
  LIS_MEDIA_TYPE_rdf_xml = 0, LIS_MEDIA_TYPE_json, LIS_MEDIA_TYPE_xml, LIS_MEDIA_TYPE_compact_xml,
  LIS_MEDIA_TYPE_compact_json
}
 
enum  LIS_properties_prefix_name_e {
  LIS_PROP_NAME_title = 0, LIS_PROP_NAME_desc, LIS_PROP_NAME_domain, LIS_PROP_NAME_details,
  LIS_PROP_NAME_identifier, LIS_PROP_NAME_publisher, LIS_PROP_NAME_usage, LIS_PROP_NAME_icon,
  LIS_PROP_NAME_label, LIS_PROP_NAME_oauth_configuration, LIS_PROP_NAME_prefix_definition, LIS_PROP_NAME_service,
  LIS_PROP_NAME_service_provider, LIS_PROP_NAME_service_provider_catalog, LIS_PROP_NAME_creation_factory, LIS_PROP_NAME_query_capability,
  LIS_PROP_NAME_dialog, LIS_PROP_NAME_creation_dialog, LIS_PROP_NAME_selection_dialog, LIS_PROP_NAME_creation,
  LIS_PROP_NAME_resource_shape, LIS_PROP_NAME_resource_type, LIS_PROP_NAME_query_base, LIS_PROP_NAME_hint_width,
  LIS_PROP_NAME_hint_height, LIS_PROP_NAME_document, LIS_PROP_NAME_short_title, LIS_PROP_NAME_small_preview,
  LIS_PROP_NAME_large_preview, LIS_PROP_NAME_type, LIS_PROP_NAME_property, LIS_PROP_NAME_describes,
  LIS_PROP_NAME_name, LIS_PROP_NAME_occurs, LIS_PROP_NAME_property_definition, LIS_PROP_NAME_range,
  LIS_PROP_NAME_representation, LIS_PROP_NAME_valueType, LIS_PROP_NAME_readOnly, LIS_PROP_NAME_rdfsMember,
  LIS_PROP_NAME_oslcCount, LIS_PROP_NAME_status_code, LIS_PROP_NAME_message, LIS_PROP_NAME_extended_error,
  LIS_PROP_NAME_more_info, LIS_PROP_NAME_rel
}
 
enum  LIS_properties_range_type_e { LIS_PROP_RANGE_any = 0, LIS_PROP_RANGE_na }
 
enum  LIS_properties_representation_type_e { LIS_PROP_REPRESENTATION_reference = 0, LIS_PROP_REPRESENTATION_inline, LIS_PROP_REPRESENTATION_either, LIS_PROP_REPRESENTATION_na }
 
enum  LIS_properties_value_occurs_e {
  LIS_PROP_OCCURS_exactly_one = 0, LIS_PROP_OCCURS_zero_or_one, LIS_PROP_OCCURS_zero_or_many, LIS_PROP_OCCURS_one_or_many,
  LIS_PROP_OCCURS_any
}
 
enum  LIS_properties_value_type_e {
  LIS_PROP_TYPE_boolean = 0, LIS_PROP_TYPE_decimal, LIS_PROP_TYPE_double, LIS_PROP_TYPE_float,
  LIS_PROP_TYPE_integer, LIS_PROP_TYPE_date_time, LIS_PROP_TYPE_string, LIS_PROP_TYPE_xml_literal,
  LIS_PROP_TYPE_resource, LIS_PROP_TYPE_local_resource, LIS_PROP_TYPE_typed_reference, LIS_PROP_TYPE_untyped_reference,
  LIS_PROP_TYPE_external_reference, LIS_PROP_TYPE_typed_relation, LIS_PROP_TYPE_untyped_relation, LIS_PROP_TYPE_untyped
}
 

Detailed Description

This file contains the declaration for the LIS toolkit property attribute types and constants defined by OSLC specifications Open Services for Lifecycle Collaboration (OSLC) specifiications provide a list of properties allowed and/or required for a particular domain and operation on an OSLC defined resource. Specifications that provide a list of properties and constraints on them provide the following information for each property that it define.

Definition in file lis_datatypes.h.

Macro Definition Documentation

#define LIS_DCTERMS_NAMESPACE_PREFIX   "dcterms"

Defines dcterms prefix

Definition at line 162 of file lis_datatypes.h.

#define LIS_OSLC_CM_CORE_NAMESPACE_PREFIX   "oslc_cm"

Defines oslc cm core prefix

Definition at line 187 of file lis_datatypes.h.

#define LIS_OSLC_CORE_NAMESPACE_PREFIX   "oslc"

Defines oslc core prefix

Definition at line 167 of file lis_datatypes.h.

#define LIS_OSLC_DATA_NAMESPACE_PREFIX   "oslc_data"

Defines oslc data prefix

Definition at line 172 of file lis_datatypes.h.

#define LIS_RDF_NAMESPACE_PREFIX   "rdf"

Defines rdf prefix

Definition at line 177 of file lis_datatypes.h.

#define LIS_RDFS_NAMESPACE_PREFIX   "rdfs"

Defines rdfs prefix

Definition at line 182 of file lis_datatypes.h.

Typedef Documentation

Defines different values that can be used as LIS media types

Defines different values that can be used as LIS Property names along with prefix
Valid prefix values are dcterms, rdf, rdfs, oslc, oslc_cm, which are explained below

Defines different values that can be used as LIS Property Range
Range for properties with a resource value-type.
Open Services for Lifecycle Collaboration (OSLC) specifications which usually results in no restrictions on the range of possible resource types allowed.

Defines different values that can be used as LIS Property Representation types Representation for properties with a resource value-type, OSLC specifications specify the respresentation of the resource.

Defines different values that can be used as LIS Property Occurs .

Defines different values that can be used as LIS property types A property may allow multiple value-types and a value must satisfy one or more of them. Each value-type must be a URI that corresponds to one of the following

Enumeration Type Documentation

Defines different values that can be used as LIS media types

Enumerator
LIS_MEDIA_TYPE_rdf_xml 

Media type RDF+XML.

LIS_MEDIA_TYPE_json 

Media type JSON.

LIS_MEDIA_TYPE_xml 

Media type XML.

LIS_MEDIA_TYPE_compact_xml 

Media type Compact XML.

LIS_MEDIA_TYPE_compact_json 

Media type Compact JSON.

Definition at line 28 of file lis_datatypes.h.

Defines different values that can be used as LIS Property names along with prefix
Valid prefix values are dcterms, rdf, rdfs, oslc, oslc_cm, which are explained below

Enumerator
LIS_PROP_NAME_title 

Property dcterms:title

LIS_PROP_NAME_desc 

Property dcterms:description

LIS_PROP_NAME_domain 

Property oslc:domain

LIS_PROP_NAME_details 

Property oslc:details

LIS_PROP_NAME_identifier 

Property dcterms:identifier

LIS_PROP_NAME_publisher 

Property dcterms:publisher

LIS_PROP_NAME_usage 

Property oslc:usage

LIS_PROP_NAME_icon 

Property oslc:icon

LIS_PROP_NAME_label 

Property oslc:label

LIS_PROP_NAME_oauth_configuration 

Property oslc:oauthConfiguration

LIS_PROP_NAME_prefix_definition 

Property oslc:prefixDefinition

LIS_PROP_NAME_service 

Property oslc:service

LIS_PROP_NAME_service_provider 

Property oslc:serviceProvider

LIS_PROP_NAME_service_provider_catalog 

Property oslc:serviceProviderCatalog

LIS_PROP_NAME_creation_factory 

Property oslc:creationFactory

LIS_PROP_NAME_query_capability 

Property oslc:queryCapability

LIS_PROP_NAME_dialog 

Property oslc:dialog

LIS_PROP_NAME_creation_dialog 

Property oslc:creationDialog

LIS_PROP_NAME_selection_dialog 

Property oslc:selectionDialog

LIS_PROP_NAME_creation 

Property oslc:creation

LIS_PROP_NAME_resource_shape 

Property oslc:resourceShape

LIS_PROP_NAME_resource_type 

Property oslc:resourceType

LIS_PROP_NAME_query_base 

Property oslc:queryBase

LIS_PROP_NAME_hint_width 

Property oslc:hintWidth

LIS_PROP_NAME_hint_height 

Property oslc:hintHeight

LIS_PROP_NAME_document 

Property oslc:document

LIS_PROP_NAME_short_title 

Property oslc:shortTitle

LIS_PROP_NAME_small_preview 

Property oslc:smallPreview

LIS_PROP_NAME_large_preview 

Property oslc:largePreview

LIS_PROP_NAME_type 

Property dcterms:type

LIS_PROP_NAME_property 

Property oslc:property

LIS_PROP_NAME_describes 

Property oslc:describes

LIS_PROP_NAME_name 

Property oslc:name

LIS_PROP_NAME_occurs 

Property oslc:occurs

LIS_PROP_NAME_property_definition 

Property oslc:propertyDefinition

LIS_PROP_NAME_range 

Property oslc:range

LIS_PROP_NAME_representation 

Property oslc:representation

LIS_PROP_NAME_valueType 

Property oslc:valueType

LIS_PROP_NAME_readOnly 

Property oslc:readOnly

LIS_PROP_NAME_rdfsMember 

Property oslc:member

LIS_PROP_NAME_oslcCount 

Property oslc:totalCount

LIS_PROP_NAME_status_code 

Property oslc:statusCode

LIS_PROP_NAME_message 

Property oslc:message

LIS_PROP_NAME_extended_error 

Property oslc:extendedError

LIS_PROP_NAME_more_info 

Property oslc:moreInfo

LIS_PROP_NAME_rel 

Property oslc:rel

Definition at line 96 of file lis_datatypes.h.

Defines different values that can be used as LIS Property Range
Range for properties with a resource value-type.
Open Services for Lifecycle Collaboration (OSLC) specifications which usually results in no restrictions on the range of possible resource types allowed.

Enumerator
LIS_PROP_RANGE_any 

Property range Any

LIS_PROP_RANGE_na 

Property range Not applicable

Definition at line 152 of file lis_datatypes.h.

Defines different values that can be used as LIS Property Representation types Representation for properties with a resource value-type, OSLC specifications specify the respresentation of the resource.

Enumerator
LIS_PROP_REPRESENTATION_reference 

Property representation http://open-services.net/ns/core#Reference

LIS_PROP_REPRESENTATION_inline 

Property representation http://open-services.net/ns/core#Inline

LIS_PROP_REPRESENTATION_either 

Property representation http://open-services.net/ns/core#Either

LIS_PROP_REPRESENTATION_na 

Property representation Not Applicable.

Definition at line 70 of file lis_datatypes.h.

Defines different values that can be used as LIS Property Occurs .

Enumerator
LIS_PROP_OCCURS_exactly_one 

Property occrurs http://open-services.net/ns/core#Exactly-one

LIS_PROP_OCCURS_zero_or_one 

Property occrurs http://open-services.net/ns/core#Zero-or-one

LIS_PROP_OCCURS_zero_or_many 

Property occrurs http://open-services.net/ns/core#Zero-or-many

LIS_PROP_OCCURS_one_or_many 

Property occrurs http://open-services.net/ns/core#One-or-many

LIS_PROP_OCCURS_any 

property occrurs http://open-services.net/ns/core#Any

Definition at line 82 of file lis_datatypes.h.

Defines different values that can be used as LIS property types A property may allow multiple value-types and a value must satisfy one or more of them. Each value-type must be a URI that corresponds to one of the following

Enumerator
LIS_PROP_TYPE_boolean 

Property type boolean, http://www.w3.org/2001/XMLSchema#boolean.

LIS_PROP_TYPE_decimal 

Property type decimal, http://www.w3.org/2001/XMLSchema#decimal

LIS_PROP_TYPE_double 

Property type doubls, http://www.w3.org/2001/XMLSchema#double

LIS_PROP_TYPE_float 

Property type float, http://www.w3.org/2001/XMLSchema#dfloat,

LIS_PROP_TYPE_integer 

Property type integer, http://www.w3.org/2001/XMLSchema#integer

LIS_PROP_TYPE_date_time 

Property type data time, http://www.w3.org/2001/XMLSchema#dateTime

LIS_PROP_TYPE_string 

Property type string, http://www.w3.org/2001/XMLSchema#string

LIS_PROP_TYPE_xml_literal 

Property type XML literal, http://www.w3.org/1999/02/22-rdf-syntax-ns#XMLLiteral

LIS_PROP_TYPE_resource 

Property type resource, http://open-services.net/ns/core#AnyResource

LIS_PROP_TYPE_local_resource 

Property type local resource, http://open-services.net/ns/core#LocalResource

LIS_PROP_TYPE_typed_reference 

Property type typed reference, http://open-services.net/ns/core#Reference

LIS_PROP_TYPE_untyped_reference 

Property type untyped reference, http://open-services.net/ns/core#Reference

LIS_PROP_TYPE_external_reference 

Property type external refernce, http://open-services.net/ns/core#Reference

LIS_PROP_TYPE_typed_relation 

Property type typed relation, http://open-services.net/ns/core#Reference

LIS_PROP_TYPE_untyped_relation 

Property type untyped relation, http://open-services.net/ns/core#Reference

LIS_PROP_TYPE_untyped 

Property type untyped, http://open-services.net/ns/core#AnyResource

Definition at line 44 of file lis_datatypes.h.