Namespace: OpenEdge.Web.DataObject
Class
SchemaOption
Parent classes:
Progress.Lang.Object
OpenEdge.Web.DataObject.SchemaOption

Inherits: Progress.Lang.Object

/* *************************************************************************************************************************
Copyright (c) 2017-2018 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:SchemaOption
Purpose:Stores schema options for an operation. Used to customise/
overide the structure of the schema returned by an operation
Author(s):pjudge
Created:2017-08-21
Notes:* The ChildSchema collection is internally managed since
we don't want to init the collection (it's not typically
going to be populated).
Purpose: (mandatory) The name of this schema element




Method Summary
Options Name Purpose
OpenEdge.Web.DataObject.SchemaOption GetChildSchema (character) /** Returns a named child schema @param character The schema name @param SchemaOption A valid schema object it exists; null/unknown otherwise */
CHARACTER GetChildSchemas () /** Returns an array of all the child schema names @return character[] An array of child schema names; if no child schema exists, an intdeterminate array returns. */
LOGICAL HasChildSchema () /** Returns TRUE if there is at least one child schema option @param logical TRUE if there is at least one child schema option, FALSE otherwise */
LOGICAL HasChildSchema (character) /** Returns TRUE if there is a child schema option @param character The child schema name @param logical TRUE if the named schema exists, FALSE otherwise */
PutChildSchema (SchemaOption) /** Adds or replaces a child schema option @param SchemaOption The child schema */
RemoveChildSchema (character) /** Removes a child schema option @param SchemaOption The child schema */
CHARACTER ToString ()

Constructor Summary
Options Name Purpose
SchemaOption () /** Default constructor. Private since we require a SchemaName */
SchemaOption (character) /* Constructor. @param character The schema name */

Property Summary
Options Name Purpose
LOGICAL Hidden
CHARACTER SchemaName
CHARACTER SerializeName


Method Detail
Top

PUBLIC OpenEdge.Web.DataObject.SchemaOption GetChildSchema (character)
Purpose: Returns a named child schema
Parameters:
pChildOption CHARACTER
Returns OpenEdge.Web.DataObject.SchemaOption
Top

PUBLIC CHARACTER GetChildSchemas ()
Purpose: Returns an array of all the child schema names
intdeterminate array returns.
Returns CHARACTER
character[] An array of child schema names; if no child schema exists, an
Top

PUBLIC LOGICAL HasChildSchema ()
Purpose: Returns TRUE if there is at least one child schema option
Returns LOGICAL
Top

PUBLIC LOGICAL HasChildSchema (character)
Purpose: Returns TRUE if there is a child schema option
Parameters:
pChildOption CHARACTER
Returns LOGICAL
Top

PUBLIC PutChildSchema (SchemaOption)
Purpose: Adds or replaces a child schema option
Parameters:
pChildOption OpenEdge.Web.DataObject.SchemaOption
Top

PUBLIC RemoveChildSchema (character)
Purpose: Removes a child schema option
Parameters:
pChildOption CHARACTER
Top

PUBLIC CHARACTER ToString ()
Returns CHARACTER


Constructor Detail
Top

PRIVATE SchemaOption ()
Purpose: Default constructor. Private since we require a SchemaName
Top

PUBLIC SchemaOption (character)
/* Constructor.
Parameters:
pName CHARACTER


Property Detail
Top

PUBLIC LOGICAL Hidden
Returns LOGICAL
Top

PUBLIC CHARACTER SchemaName
Returns CHARACTER
Top

PUBLIC CHARACTER SerializeName
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0