Module TypeService

Macros to describe the item type definitions within the system.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_getcontextallowablechildren(lsaf_typeid=, sas_dsname=work.lsafGetContextAllowableChildren);
Gets the metadata for the item types that can be created as immediate children of the ...
external

LSAF
%lsaf_getcontexttypes(sas_dsname=work.lsafGetContextTypes);
Gets the metadata for all of the context types that are defined in the repository. The metadata ...
external

LSAF
%lsaf_getsearchabletypes(sas_dsname=work.lsafGetSearchableTypes);
Gets the metadata for all of the searchable types that are defined in the repository. The ...
external

LSAF
%lsaf_iscontexttype(lsaf_typeid=);
Indicates whether the specified type identifier is a context.
external

LSAF
%lsaf_typehascapability(lsaf_typeid=, lsaf_capability=);
Indicates whether the type has the specified capability in the repository.

Macro Detail

%lsaf_getcontextallowablechildren(lsaf_typeid=, sas_dsname=work.lsafGetContextAllowableChildren);

[ Exposure: external ]
Gets the metadata for the item types that can be created as immediate children of the
specified context type in the repository. The metadata is stored in a SAS data set.

To get a list of valid context types, run the macro %lsaf_getcontexttypes().

Syntax:
%LSAF_GETCONTEXTALLOWABLECHILDREN(LSAF_TYPEID=lsaf-typeid, SAS_DSNAME=SAS-data-set>);

          
History:
   2019-01-15
initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_typeid - - Required - The type identifier of the context item in the repository.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the items, specified as libref.dataset. The default value is
        WORK.LSAFGETCONTEXTALLOWABLECHILDREN. The data set contains a row for each item
        in the list and columns with the following names. The data set is sorted by the
        id.
        - ListType: The list type, in this case Context allowable children.
        - typeId: The context type ID.
        - id: The child ID of the item.
        - name: The name of the item.
        - description: The description of the item.
        - lsafType: The type of the item.
        - allowableChildTypes: The allowable child types for this item.
        - capabilities: The capabilities of this child.
File: lsaf_getcontextallowablechildren.sas
First available in version: 2.1

%lsaf_getcontexttypes(sas_dsname=work.lsafGetContextTypes);

[ Exposure: external ]
Gets the metadata for all of the context types that are defined in the repository. The metadata
is stored in a SAS data set.

Syntax:
%LSAF_GETCONTEXTTYPES(SAS_DSNAME=SAS-data-set);

Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Optional - The name of the output SAS data set to the metadata for the
        context types, specified as libref.dataset. The default value is
        WORK.LSAFGETCONTEXTTYPES. The data set contains a row for each context, sorted by
        the context ID, and columns with the following names:
        - ListType: The list type, in this case Context.
        - Id: The unique identifier for the context.
        - Name: The display name for the context.
        - Description: The description for the context.
        - LsafType: The type, in this case Context.
        - AllowableChildren: The identifier for the immediate children of the context.
        - Capabilities: The functionality enabled by the context.
File: lsaf_getcontexttypes.sas
First available in version: 2.1

%lsaf_getsearchabletypes(sas_dsname=work.lsafGetSearchableTypes);

[ Exposure: external ]
Gets the metadata for all of the searchable types that are defined in the repository. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETSEARCHABLETYPES(SAS_DSNAME=SAS-data-set);

Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Optional - The name of the output SAS data set to the metadata for the
        searchable types, specified as libref.dataset. The default value is
        WORK.LSAFGETSEARCHABLETYPES. The data set contains a row for each searchable type,
        sorted by the ID, and columns with the following names:
        - ListType: The list type, in this case Searchable.
        - Id: The unique identifier for the item.
        - Name: The display name for the item.
        - Description: The description for the item.
        - LsafType: The type, such as Context, File, Folder.
File: lsaf_getsearchabletypes.sas
First available in version: 2.2

%lsaf_iscontexttype(lsaf_typeid=);

[ Exposure: external ]
Indicates whether the specified type identifier is a context.

The SAS macro variable _lsafIsContextType_ is set to a value of 1, if the specified item is a
context item, 0 if it is not. In the event of an incorrect call to the macro that results in an
error, the return value of _lsafIsContextType_ is set to -1. To get a list of the valid context
types, run %lsaf_getcontexttypes().

Syntax:
%LSAF_ISCONTEXTTYPE(LSAF_TYPEID=lsaf-typeid);

          
History:
   2019-01-15
initial coding
Expected Macro Variables:
_lsafIsContextType_ - Indicates whether the value is a context type.
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_typeid - - Required - The context type identifier of the item in the repository.
File: lsaf_iscontexttype.sas
First available in version: 2.1

%lsaf_typehascapability(lsaf_typeid=, lsaf_capability=);

[ Exposure: external ]
Indicates whether the type has the specified capability in the repository.

The SAS macro variable _lsafTypeHasCapability_ is set to a value of 1, if the specified item has
the capability, 0 if it does not. In the event of an incorrect call to the macro that results in an
error, the return value of _lsafTypeHasCapability_ is set to -1. To get a list of the valid context
types, run %lsaf_getcontexttypes().

Syntax:
%LSAF_TYPEHASCAPABILITY(LSAF_TYPEID=lsaf-typeid, LSAF_CAPABILITY=lsaf-capability);

          
History:
   2019-03-04
initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
_lsafTypeHasCapability_ - Indicates whether the type has the capability.
Parameters:
lsaf_typeid - - Required - The type identifier of the item.
lsaf_capability - - Required - The specified capability of the item.
File: lsaf_typehascapability.sas
First available in version: 2.1