com.sap.caf.eu.gp.bo.template.reader.api

Interface IGPPatternTemplateReader

public interface IGPPatternTemplateReader

Version:

1.0

Method Summary

Enumeration	readTemplateDetailEnumeration(IUser user, IGPBusinessObjectEndpoint endpoint, String nameParent, String pattern, boolean deep) Read a Detail Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader.
Enumeration	readTemplateNameEnumeration(IUser user, IGPBusinessObjectEndpoint endpoint, String nameParent, String pattern, boolean deep) Read a Name Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader.
Enumeration	readTemplateOverviewEnumeration(IUser user, IGPBusinessObjectEndpoint endpoint, String nameParent, String pattern, boolean deep) Read an Overview Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader.

Method Detail

readTemplateDetailEnumeration

Enumeration readTemplateDetailEnumeration(IUser user,
                                          IGPBusinessObjectEndpoint endpoint,
                                          String nameParent,
                                          String pattern,
                                          boolean deep)
                                          throws GPEngineException,
                                                 GPInvocationException

Read a Detail Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader. Only BusinessObjectTemplate with a Name matching the given Pattern take part in the read process. The Enumeration contains IGPBusinessObjectTemplateDetail entries in random sequence.

Parameters:

user - the user used during the read process, never null

endpoint - the Endpoint from which to read the Enumeration, null for providers operating locally

nameParent - the Name of the parent node, null for the root node

pattern - the Pattern by which to restrict the read process, null for no restriction

deep - true to include all node children in the read process, false to restrict the read process to direct children

Returns:

the read Enumeration, never null

Throws:

GPEngineException - in case the Enumeration could not be read due to internal problems

GPInvocationException - in case the given UserContext is invalid

readTemplateNameEnumeration

Enumeration readTemplateNameEnumeration(IUser user,
                                        IGPBusinessObjectEndpoint endpoint,
                                        String nameParent,
                                        String pattern,
                                        boolean deep)
                                        throws GPEngineException,
                                               GPInvocationException

Read a Name Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader. Only BusinessObjectTemplate with a Name matching the given Pattern take part in the read process. The Enumeration contains String entries in random sequence.

Parameters:

user - the user used during the read process, never null

endpoint - the Endpoint from which to read the Enumeration, null for providers operating locally

nameParent - the Name of the parent node, null for the root node

pattern - the Pattern by which to restrict the read process, null for no restriction

deep - true to include all node children in the read process, false to restrict the read process to direct children

Returns:

the read Enumeration, never null

Throws:

GPEngineException - in case the Enumeration could not be read due to internal problems

GPInvocationException - in case the given UserContext is invalid

readTemplateOverviewEnumeration

Enumeration readTemplateOverviewEnumeration(IUser user,
                                            IGPBusinessObjectEndpoint endpoint,
                                            String nameParent,
                                            String pattern,
                                            boolean deep)
                                            throws GPEngineException,
                                                   GPInvocationException

Read an Overview Enumeration of BusinessObjectTemplate accessible through this PatternTemplateReader. Only BusinessObjectTemplate with a Name matching the given Pattern take part in the read process. The Enumeration contains IGPBusinessObjectTemplateOverview entries in random sequence.

Parameters:

user - the user used during the read process, never null

endpoint - the Endpoint from which to read the Enumeration, null for providers operating locally

nameParent - the Name of the parent node, null for the root node

pattern - the Pattern by which to restrict the read process, null for no restriction

deep - true to include all node children in the read process, false to restrict the read process to direct children

Returns:

the read Enumeration, never null

Throws:

GPEngineException - in case the Enumeration could not be read due to internal problems

GPInvocationException - in case the given UserContext is invalid