LabelService (Bitbucket Server

```
public interface LabelService
```
Describes a service for interacting with labels.

Since:

5.12

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Label`	`apply(ApplyLabelRequest request)` Add a `Label` to a `Labelable`.
`Label`	`create(String labelName)` Creates a new label based on the given labelName.
`Page<Label>`	`findAll(PageRequest pageRequest)` Retrieves a `Page` of `Label` for all the labels in the system.
`Page<Label>`	`findByLabelable(Labelable labelable, PageRequest pageRequest)` returns a `Page` of `labels` related to this `Labelable`
`Optional<Label>`	`findByName(String labelName)` Returns an `Optional` containing a `Label` based on the name.
`Page<Label>`	`findByPrefix(String labelPref, PageRequest pageRequest)` returns a `Page` of `labels` based on a prefix.
`Label`	`getByName(String labelName)` Returns a `Label` based on the name.
`void`	`remove(RemoveLabelRequest request)` Removes a `Label` from a `Labelable`.
`Page<Labelable>`	`searchLabelables(LabelableSearchRequest searchRequest, PageRequest pageRequest)` Returns `Page` of `labelables` for a given `LabelableSearchRequest`.

Method Detail

apply
```
@Nonnull
Label apply(@Nonnull
                     ApplyLabelRequest request)
```
Add a Label to a Labelable.

Parameters:

request - request containing the Label and Labelable

Returns:

the Label that was added.

create
```
@Nonnull
Label create(@Nonnull
                      String labelName)
```
Creates a new label based on the given labelName.
The labelName has to be at least 3 characters and cannot exceed 50 characters, the labelName also has to be a lowercase string consisting out of alpanumeric characters, "-" is also allowed.

Parameters:

labelName - the name for the newly created label.

Returns:

the created Label

findAll

@Nonnull
Page<Label> findAll(@Nonnull
                             PageRequest pageRequest)

Retrieves a Page of Label for all the labels in the system.

Parameters:: pageRequest - the PageRequest
Returns:: Page of Label

findByLabelable

@Nonnull
Page<Label> findByLabelable(@Nonnull
                                     Labelable labelable,
                                     @Nonnull
                                     PageRequest pageRequest)

returns a Page of labels related to this Labelable

Parameters:: labelable - the Labelable that will have it's related labels returned; pageRequest - the PageRequest
Returns:: Page of Label

findByName

@Nonnull
Optional<Label> findByName(@Nonnull
                                    String labelName)

Returns an Optional containing a Label based on the name.

Parameters:: labelName - name of the Label
Returns:: Optional containing a Label

findByPrefix

@Nonnull
Page<Label> findByPrefix(@Nonnull
                                  String labelPref,
                                  @Nonnull
                                  PageRequest pageRequest)

returns a Page of labels based on a prefix.

Parameters:: labelPref - the prefix the labels have to start with; pageRequest - the PageRequest
Returns:: Page of Label

getByName

@Nonnull
Label getByName(@Nonnull
                         String labelName)

Returns a Label based on the name.

Parameters:: labelName - name of the Label
Returns:: a Label

searchLabelables

@Nonnull
Page<Labelable> searchLabelables(@Nonnull
                                          LabelableSearchRequest searchRequest,
                                          @Nonnull
                                          PageRequest pageRequest)

Returns Page of labelables for a given LabelableSearchRequest.

Parameters:: searchRequest - a LabelableSearchRequest; pageRequest - the PageRequest
Returns:: Page of labelables

remove
```
void remove(@Nonnull
            RemoveLabelRequest request)
```
Removes a Label from a Labelable.

Parameters:

request - request containing the Label and Labelable

Interface LabelService