IPPStringTypeCustomFieldDefinition.php
Show:
inherited
inherited
Classes
- Package
- Default
\IPPStringTypeCustomFieldDefinition
Package: Default
- Parent(s)
- \IPPCustomFieldDefinition < \IPPIntuitEntity
- Inherited_from
- \IPPCustomFieldDefinition
- IPPStringTypeCustomFieldDefinition
- \IPPStringTypeCustomFieldDefinition
- XmlDefinition
- Product: ALL Description: Provides for strong-typing of the StringType CustomField.
- XmlName
- IPPStringTypeCustomFieldDefinition
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- CustomFieldDefinition
Properties
string $AppIdDetails
- Type
- string
- Definition
- Product: ALL Description: Identifier of Partner AppId that corresponds to this CustomField.
- XmlMinOccurs
- 0
- XmlName
- AppId
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
\com\intuit\schema\finance\v3\IPPAttachableRef $AttachableRefDetails
- Type
- \com\intuit\schema\finance\v3\IPPAttachableRef
- Definition
- Specifies entity name of the attachment from where the attachment was requested
- XmlMaxOccurs
- unbounded
- XmlMinOccurs
- 0
- XmlName
- AttachableRef
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
\com\intuit\schema\finance\v3\IPPCustomField $CustomFieldDetails
- Type
- \com\intuit\schema\finance\v3\IPPCustomField
- Definition
- Product: QBW Description: Custom field (or data extension). Filterable: QBW
- XmlMaxOccurs
- unbounded
- XmlMinOccurs
- 0
- XmlName
- CustomField
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $DefaultStringDetails
- Type
- string
- Definition
- Product: ALL Description: Default string value of the StringType CustomField.[br /]Max. length: 31 characters.
- XmlMinOccurs
- 0
- XmlName
- DefaultString
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $EntityTypeDetails
- Type
- string
- Definition
- Product: ALL Description: Intuit entity type to which the CustomFieldDefinition is associated. Valid values are defined in the objectNameEnumType.[br /]Required for the create operation. Required: ALL
- XmlMinOccurs
- 0
- XmlName
- EntityType
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
boolean $HiddenDetails
- Type
- boolean
- Definition
- Product: ALL Description: True if the custom field is Private; false if Public and can be shared among different applications.
- XmlMinOccurs
- 0
- XmlName
- Hidden
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
\com\intuit\schema\finance\v3\IPPid $IdDetails
- Type
- \com\intuit\schema\finance\v3\IPPid
- Definition
- Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
- XmlMinOccurs
- 0
- XmlName
- Id
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
integer $MaxLengthDetails
- Type
- integer
- Definition
- Product: ALL Description: Maximum length allowed for the value of the string when creating/updating a StringType CustomField.
- XmlMinOccurs
- 0
- XmlName
- MaxLength
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
\com\intuit\schema\finance\v3\IPPModificationMetaData $MetaDataDetails
- Type
- \com\intuit\schema\finance\v3\IPPModificationMetaData
- Definition
- Product: ALL Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
- XmlMinOccurs
- 0
- XmlName
- MetaData
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $NameDetails
- Type
- string
- Definition
- Product: ALL Description: Name of the CustomField entity.[br /]Required for the create operation. Required: ALL
- XmlMinOccurs
- 0
- XmlName
- Name
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $RegularExpressionDetails
- Type
- string
- Definition
- Product: ALL Description: The regular expression string used to validate the StringType CustomField value.[br /]Max. length: 31 characters.
- XmlMinOccurs
- 0
- XmlName
- RegularExpression
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
boolean $RequiredDetails
- Type
- boolean
- Definition
- Product: ALL Description: True if the custom field must be specified for every instance of the Parent entity for which the CustomFieldDefinition is defined. Data Services dpes not verify the value of that field.
- XmlMinOccurs
- 0
- XmlName
- Required
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $SyncTokenDetails
- Type
- string
- Definition
- Product: ALL Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation. Required: ALL
- XmlMinOccurs
- 0
- XmlName
- SyncToken
- XmlNamespace
- http://schema.intuit.com/finance/v3
- XmlType
- element
string $domainDetails
- Type
- string
- Definition
- Product: ALL Description: Domain in which the entity belongs.
- XmlName
- domain
- XmlType
- attribute
boolean $sparseDetails
- Type
- boolean
- Definition
- Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
- XmlName
- sparse
- XmlType
- attribute
array<mixed,\EntityStatusEnum> $statusDetails
- Type
- array<mixed,\EntityStatusEnum>
- Definition
- Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
- XmlName
- status
- XmlType
- attribute
Methods
__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : voidInitializes this object, optionally with pre-defined property values
Initializes this object and it's property members, using the dictionary
of key/value pairs passed as an optional argument.
Parameters| Name | Type | Description |
|---|---|---|
| $keyValInitializers | \dictionary | key/value pairs to be populated into object's properties |
| $verbose | boolean | specifies whether object should echo warnings |
__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : voidinherited
Initializes this object, optionally with pre-defined property values
Inherited from:Initializes this object and it's property members, using the dictionary
of key/value pairs passed as an optional argument.
Parameters| Name | Type | Description |
|---|---|---|
| $keyValInitializers | \dictionary | key/value pairs to be populated into object's properties |
| $verbose | boolean | specifies whether object should echo warnings |