com.ardoq.service

Interface ComponentService

public interface ComponentService

Method Summary

Modifier and Type	Method and Description
Component	createComponent(Component component)
void	createComponent(Component component, retrofit.Callback<Component> callback)
retrofit.client.Response	deleteComponent(String id)
void	deleteComponent(String id, retrofit.Callback<retrofit.client.Response> callback)
List<Component>	findComponentsByFields(Map<String,String> fields) Find components by one or more fields.
List<Component>	findComponentsByFields(Map<String,String> fields, retrofit.Callback<Component> callback)
List<Component>	findComponentsInWorkspaceByName(String workspaceId, String name)
List<Component>	findComponentsInWorkspaceByName(String workspaceId, String name, retrofit.Callback<Component> callback)
List<Component>	getAllComponents()
void	getAllComponents(retrofit.Callback<List<Component>> callback)
Component	getComponentById(String id)
void	getComponentById(String id, retrofit.Callback<Component> callback)
Component	updateComponent(String id, Component component) Updates a component and returns a NEW immutable component.
void	updateComponent(String id, Component component, retrofit.Callback<Component> callback)

Method Detail

getAllComponents

@GET(value="/api/component")
List<Component> getAllComponents()

getAllComponents

@GET(value="/api/component")
void getAllComponents(retrofit.Callback<List<Component>> callback)

getComponentById

@GET(value="/api/component/{id}")
Component getComponentById(@Path(value="id")
                                                             String id)

getComponentById

@GET(value="/api/component/{id}")
void getComponentById(@Path(value="id")
                                                        String id,
                                                        retrofit.Callback<Component> callback)

findComponentsByFields

@GET(value="/api/component/fieldsearch")
List<Component> findComponentsByFields(@QueryMap
                                                                                Map<String,String> fields)

Find components by one or more fields. A field matches if the field equals the query (partial matches are not returned). If multiple fields are passed it will return components where all fields match.

Parameters:

fields - Map<String,String> fieldName -> expectedFieldValue

findComponentsByFields

@GET(value="/api/component/fieldsearch")
List<Component> findComponentsByFields(@QueryMap
                                                                                Map<String,String> fields,
                                                                                retrofit.Callback<Component> callback)

findComponentsInWorkspaceByName

@GET(value="/api/component/search")
List<Component> findComponentsInWorkspaceByName(@Query(value="workspace")
                                                                                    String workspaceId,
                                                                                    @Query(value="name")
                                                                                    String name)

findComponentsInWorkspaceByName

@GET(value="/api/component/search")
List<Component> findComponentsInWorkspaceByName(@Query(value="workspace")
                                                                                    String workspaceId,
                                                                                    @Query(value="name")
                                                                                    String name,
                                                                                    retrofit.Callback<Component> callback)

createComponent

@POST(value="/api/component")
Component createComponent(@Body
                                                        Component component)

createComponent

@POST(value="/api/component")
void createComponent(@Body
                                                   Component component,
                                                   retrofit.Callback<Component> callback)

updateComponent

@PUT(value="/api/component/{id}")
Component updateComponent(@Path(value="id")
                                                            String id,
                                                            @Body
                                                            Component component)

Updates a component and returns a NEW immutable component.

Parameters:

id - The ID of the component to update

component - The component's data that you wish to update

Returns:

updated and synced component

See Also:

Component

updateComponent

@PUT(value="/api/component/{id}")
void updateComponent(@Path(value="id")
                                                       String id,
                                                       @Body
                                                       Component component,
                                                       retrofit.Callback<Component> callback)

deleteComponent

@DELETE(value="/api/component/{id}")
retrofit.client.Response deleteComponent(@Path(value="id")
                                                                              String id)

deleteComponent

@DELETE(value="/api/component/{id}")
void deleteComponent(@Path(value="id")
                                                          String id,
                                                          retrofit.Callback<retrofit.client.Response> callback)