Class ArchetypeDefinitionService

Inheritance Relationships

Base Type

Class Documentation

class ArchetypeDefinitionService : public axr::sdk::ServiceBase<ArchetypeDefinition>

Public Functions

inline ArchetypeDefinitionService(std::shared_ptr<Configuration> config, std::shared_ptr<net::IApiClient> apiClient)
inline ~ArchetypeDefinitionService()
pplx::task<std::vector<std::shared_ptr<ArchetypeDefinition>>> FindAll(const std::map<utility::string_t, utility::string_t> *searchParams = nullptr, const uint16_t startIndex = 0, const uint16_t maxResults = 1000, const utility::string_t &sortBy = _XPLATSTR(""))

Retrieves a list of objects matching the specified search parameters.

Parameters
  • searchParams – A map of property names to values to search for.

  • startIndex – The index of the first object to include in the result.

  • maxResults – The maximum number of objects to evaluate during the search.

  • sortBy – The property name and order direction to sort the results using. (e.g. “MyProperty=ASC” to sort by MyProperty in ascending order, “MyProperty=DESC” to sort by MyProperty in descending order).

Returns

A task whose result is a list of objects matching the specified search parameters.

pplx::task<uint64_t> Count(const std::map<utility::string_t, utility::string_t> *searchParams = nullptr, const uint16_t startIndex = 0, const uint16_t maxResults = 1000)

Retrieves the total number of objects matching the specified search parameters.

Parameters
  • searchParams – A map of property names to values to search for.

  • startIndex – The index of the first object to include in the result.

  • maxResults – The maximum number of objects to evaluate during the search. Value cannot exceed 1000.

Returns

A task whose result is the number of objects matching the specified search parameters.

pplx::task<std::shared_ptr<ArchetypeDefinition>> FindById(const utility::string_t &id)

Retrieves an instance of ArchetypeDefinition with the specified unique identifier.

Parameters

id – The id value which uniquely idenitifies the object.

Returns

A task whose result is the object with the specified identifier if found.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.